CData Sync App は、Yahoo! Ads データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Yahoo! Ads コネクタはCData Sync アプリケーションから使用可能で、Yahoo! Ads からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はYahoo!広告 API v14 を使用して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 はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
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 for the ad group, including Get, Add, Set, Replace, and Remove. |
| AudienceLists | Manage the audience list for site retargeting by using Create, Read, Update, or Delete for entries. |
| 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 | Manage the ad group by using the Create, Read, Update, or Delete operations. |
| 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 for the ad group, including Get, Add, Set, Replace, and Remove.
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column 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_RANGE18_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 | |
| 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 | |
| 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. 使用できる値は次のとおりです。STANDARD_LIST, EXCLUSIONS_ONLY_LIST, 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, SITE_CATEGORY, AUDIENCE_LIST_TARGET, SEARCH_TARGET, PLACEMENT_TARGET, DEVICE_TARGET, APP_TARGET, OS_TARGET, OS_VERSION_TARGET, POSITION_TARGET, PLACEMENT_CATEGORY_TARGET, PLACEMENT_CATEGORY_DETAIL_TARGET, CONTENTS_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. 使用できる値は次のとおりです。COMBINATION, SIMILARITY, WEBSITE_VISITORS, CUSTOMER_DATA, OFFERED_BY_YAHOO_JAPAN, APP_USER, YAHOO_JAPAN_AUDIENCE_DISCOVERY, ADVANCED_SEGMENTS, AD_ACTION_USERS, AFFINITY, IN_MARKET, ATTRIBUTE_LIFE_EVENTS, UNKNOWN, BUSINESS_MANAGER, LINE_OA_FRIEND, LINE_OA_BLOCK | |
| 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. |
Manage the audience list for site retargeting by using Create, Read, Update, or Delete for entries.
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column 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 AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions#TEMP (CompareOperator, RuleType, Value) VALUES ('EQUAL', 'URL', 'Cdata.com');
INSERT INTO AudienceListContentWebsiteVisitorsAudienceListRules#TEMP (RuleConditions) VALUES ( AudienceListContentWebsiteVisitorsAudienceListRulesRuleConditions#TEMP);
INSERT INTO AudienceLists(AccountId, AudienceListType, AudienceListName, ContentWebsiteVisitorsAudienceListIsOpen, ContentWebsiteVisitorsAudienceListIsPreset, ContentWebsiteVisitorsAudienceListDataDuration, ContentWebsiteVisitorsAudienceListRules,ContentWebsiteVisitorsAudienceListRetargetingTagId) VALUES (100135346, 'WEBSITE_VISITORS', 'AudName', TRUE, FALSE, 7, AudienceListContentWebsiteVisitorsAudienceListRules#TEMP,'YWQ9T6KH22');
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. 使用できる値は次のとおりです。COMBINATION, SIMILARITY, WEBSITE_VISITORS, CUSTOMER_DATA, APP_USER, YAHOO_JAPAN_AUDIENCE_DISCOVERY, ADVANCED_SEGMENTS, AD_ACTION_USERS, UNKNOWN, BUSINESS_MANAGER, LINE_OA_FRIEND, LINE_OA_BLOCK | |
| 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. | |
| ContentCustomerDataAudienceListDataDuration | Int64 | False |
Duration of user data configured from DMP (1-60days).This field is required in ADD 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 | |
| ContentWebsiteVisitorsAudienceListDataDuration | 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. | |
| ContainDataConnectionStopped | String | False |
AudienceListServiceContainDataConnectionStopped display whether the list contains audience lists that have stopped the data connection. | |
| 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. 使用できる値は次のとおりです。SITE_RETARGETING_TAG, CUSTOMER_DATA_FILE, APP_DATA, YAHOO_JAPAN_AUDIENCE_DISCOVERY, ADVANCED_SEGMENTS, AD_ACTION, UNKNOWN, LINE_OFFICIAL_ACCOUNT | |
| DataConnectionStopped | String | False |
It shows whether or not the custom list stopped the data connection. | |
| YahooJapanAudienceDiscoveryAudienceListDataDuration | 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. | |
| ContentAppUserAudienceListDataDuration | 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. | |
| AdvancedSegmentsAudienceListKeywords | String | False |
Keyword. | |
| AdvancedSegmentsAudienceListIsCurrentlyTotaling | String | False |
It displays the count status. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
| BusinessManagerAudienceList | String | False |
This is a container for audience list (business manager). | |
| AdvancedSegmentsAudienceListUrls | String | False |
Url list tied to Advanced segments. |
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, RESPONSIVE_GAIN_FRIENDS_AD | |
| 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. 使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, REGISTER, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, GAIN_FRIENDS, PLAY_GAME, USE_APP, LISTEN_TO_MUSIC, UNKNOWN | |
| 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. 使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, REGISTER, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, GAIN_FRIENDS, PLAY_GAME, USE_APP, LISTEN_TO_MUSIC, UNKNOWN | |
| 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. 使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, REGISTER, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, GAIN_FRIENDS, PLAY_GAME, USE_APP, LISTEN_TO_MUSIC, UNKNOWN | |
| 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. | |
| ResponsiveGainFriendsAdButtonText | String | False |
AdGroupAdServiceButtonText displays the button text. | |
| ResponsiveGainFriendsAdDescription | String | False |
Ad description. | |
| ResponsiveGainFriendsAdHeadline | String | False |
Ad title. | |
| ResponsiveGainFriendsAdThumbnailMediaId | Int64 | False |
Thumbnail ID. | |
| ResponsiveGainFriendsAdIsRemoveVideo10SecBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdIsRemoveVideo25PercentBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdIsRemoveVideo3SecBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdIsRemoveVideo50PercentBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdIsRemoveVideo75PercentBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdIsRemoveVideoCompleteBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdIsRemoveVideoStartBeaconUrls | String | False |
AdGroupAdServiceIsRemoveFlg is a flag for removing an information item. | |
| ResponsiveGainFriendsAdVideo10SecBeaconUrls | String | False |
Viewing beacon URL (10 seconds). | |
| ResponsiveGainFriendsAdVideo25PercentBeaconUrls | String | False |
Playback viewing beacon URL (25%). | |
| ResponsiveGainFriendsAdVideo3SecBeaconUrls | String | False |
Viewing beacon URL (3 seconds). | |
| ResponsiveGainFriendsAdVideo50PercentBeaconUrls | String | False |
Playback viewing beacon URL (50%). | |
| ResponsiveGainFriendsAdVideo75PercentBeaconUrls | String | False |
Playback viewing beacon URL (75%). | |
| ResponsiveGainFriendsAdVideoCompleteBeaconUrls | String | False |
Viewing beacon URL (complete). | |
| ResponsiveGainFriendsAdVideoStartBeaconUrls | String | False |
Viewing beacon URL (start). | |
| CarouselGainFriendsAdButtonText | String | False |
AdGroupAdServiceButtonText displays the button text. | |
| CarouselGainFriendsAdCarousels | String | False |
AdGroupAdServiceCarouselGainFriends object describes the detailed information of carousel (Gain friends) ad. |
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. |
Manage the ad group by using the Create, Read, Update, or Delete operations.
The Sync App will use 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, MAXIMIZE_GAINING_FRIENDS | |
| 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. | |
| SmartTargetingEnabled | String | False |
AdGroupServiceSmartTargetingEnabled is a flag for smart targeting. If the set value is 'TRUE', the value will be valid. This field is optional in ADD and SET operation. The default value in ADD operation will be FALSE. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
| CampaignBiddingStrategyTypeTargetCpf | Int64 | False |
Target CPF (tCPF) of ad group | |
| CampaignBiddingStrategyTypeIsRemoveTargetCpf | String | False |
If the Target CPF (tCPF) of the ad group is removed. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
| ExcludeLineOaFriendAudienceListId | Int64 | False |
The ID of the audience list of Friends of LINE Official Account to exclude. |
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' Select * from DisplayAdsCampaigns where UpdatedDate>='2023-10-13'
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, MAXIMIZE_CONVERSION_VALUE, MAXIMIZE_GAINING_FRIENDS | |
| 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 | |
| OptimizerTrainingStatus | 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. | |
| MaximizeConversionValueBiddingSchemeTargetRoas | Double | False |
Displays bidding setting for target roas. | |
| MaximizeGainingFriendsBiddingSchemeTargetCpf | Int64 | False |
Target CPF (tCPF) of campaign. | |
| MaximizeConversionsBiddingSchemeSkanTcpaTargetType | String | False |
Conversions to adjust target value (SKAdNetwork). | |
| UpdatedDate | Date | True |
Updated date. |
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 | |
| 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. | |
| LyTagConversionSnippetId | String | False |
Snippet ID. | |
| LyTagConversionRuleType | String | False |
This field describes the types of conditions for the tracking tag. 使用できる値は次のとおりです。URL, EVENT_TYPE, EVENT_SNIPPET, UNKNOWN | |
| LyTagConversionUrlRuleCompareOperator | String | False |
This field describes the types of URL filter conditions for the tracking tag. 使用できる値は次のとおりです。INCLUDED, EQUAL, START_WITH, END_WITH, NOT_EQUAL, NOT_INCLUDED, NOT_START_WITH, NOT_END_WITH, UNKNOWN | |
| LyTagConversionUrlRuleUrl | String | False |
This field describes the URL to be evaluated by the rule. |
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, DEFINITE_VALUE_MONTH, 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 (CampaignId) VALUES ('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, 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 | |
| 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 | |
| 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, PENDING_UNSPECIFIED_AD | |
| CampaignBannerFlg | String | False |
Displays the flag settings of Campaign banner image. 使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN | |
| CreatedDate | Date | True |
Date of Media made. | |
| ReviewApplicationDate | Datetime | False |
The date when you submitted the image for the review appears. | |
| 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, PENDING_UNSPECIFIED_AD | |
| CreatedDate | Date | True |
Date when the video was made. | |
| ReviewApplicationDate | Datetime | False |
The date when you submitted the video for the review appears. | |
| 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. |
| AudienceListContentAdvancedSegmentsAudienceListKeywords | Retrieve the details of the audience list (Advanced segments). |
| AudienceListContentAdvancedSegmentsAudienceListUrls | Retrieve the details of the audience list (Advanced segments urls). |
| 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. |
| 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. |
| 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. |
| DisplayAdsAdGroupAdCarouselGainFriendsAdCarousels | Retrieve the information of CarouselGainFriendsAd 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. |
| 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. |
| EstimatedUserSize | Retrieves estimated user size for keywords. |
| 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 the ad group. This object is required if you are adding an ad group via GuaranteedAdGroupService. Columns with read only=false can be inserted into the parent table using temporary 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. |
| 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 | Obtain stats for 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. Possible values are : WEBSITE_TRAFFIC,VIDEO_VIEW,APP_PROMOTION,CONVERSION,ITEM_LIST,BRAND_AWARENESS,STORE_VISIT,PAYPAY_GIFT,GAIN_FRIENDS,BRAND_AWARENESS_GUARANTEED,SHOPPING_ADS,SALES_PROMOTION,PRIVATE_MARKET_PLACE |
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, KOCHAVA, SINGULAR, UNKNOWN | |
| CategoryType | String | It displays the category type for app link. | |
| LinkId | String | Link Id. |
Retrieve the details of the audience list (Advanced segments).
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column 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 AudienceListContentAdvancedSegmentsAudienceListKeywords WHERE AccountId = '1234300'; SELECT * FROM AudienceListContentAdvancedSegmentsAudienceListKeywords WHERE AccountId = '1234300' AND AudienceListId = '1003039071';
| Name | Type | References | Description |
| AudienceListId | Int64 | Audience List ID. | |
| AccountId | Int64 |
DisplayAdsAccounts.AccountId | Account ID. |
| Keyword | String | Keyword. | |
| UnavailableKeyword | String | Whether the keyword is unavailable.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
Retrieve the details of the audience list (Advanced segments urls).
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column 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 AudienceListContentAdvancedSegmentsAudienceListUrls WHERE AccountId = '1234339' SELECT * FROM AudienceListContentAdvancedSegmentsAudienceListUrls WHERE AccountId = '1234339' AND AudienceListId = '1003039071' SELECT * FROM AudienceListContentAdvancedSegmentsAudienceListUrls 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. |
| Url | String | Url. | |
| UnavailableUrl | String | Whether the url is unavailable.
使用できる値は次のとおりです。TRUE, FALSE, UNKNOWN |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SharingStatusFilterType | String | sharing status of the target list.
使用できる値は次のとおりです。ALL, SHARED, NOT_SHARED, UNKNOWN デフォルト値はALLです。 |
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 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. |
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 information of CarouselGainFriendsAd Carousel ad.
| 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 ADD and 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 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. |
| 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. |
| 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. |
| 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 |
Retrieves estimated user size for keywords.
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The Keyword is required to make a request and the rest of the filter is executed client-side within the Sync App.
SELECT * FROM EstimatedUserSize WHERE Keyword = 'string';
SELECT * FROM EstimatedUserSize WHERE Keyword IN ('string','abc');
SELECT * FROM EstimatedUserSize WHERE Url = 'https://abcd.com';
SELECT * FROM EstimatedUserSize WHERE Url IN ('https://abcd.com','https://qwer.com');
| Name | Type | References | Description |
| EstimatedUserSize | String | Estimated user size from keywords. | |
| Keyword | String | Keywords. | |
| UnavailableKeyword | String | EstimatedUserSizeServiceUnavailableKeyword display whether the keyword is unavailable. | |
| Url | String | Url. | |
| UnavailableUrl | String | EstimatedUserSizeServiceUnavailableUrl display whether the url is unavailable. |
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 the ad group. This object is required if you are adding an ad group via GuaranteedAdGroupService. Columns with read only=false can be inserted into the parent table using temporary 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 | |
| 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) | |
| AdPlacementName | String | Ad place name |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| KeywordFilterTypes | String | The type of search keyword
使用できる値は次のとおりです。URL, AD_PLACE_NAME, UNKNOWN | |
| AdPlaceFilterTypes | String | The type of ad place to be searched.
使用できる値は次のとおりです。MAIN_AD_PLACE, UNKNOWN | |
| Lang | String | The language selection of the ad place name in the response.
使用できる値は次のとおりです。EN, JA, UNKNOWN | |
| UnknownUrlFilterType | String | Item to filter unknown URLs in the search results
使用できる値は次のとおりです。DISPLAY, HIDE, UNKNOWN | |
| SortField | String | The sorting field
使用できる値は次のとおりです。URL, AD_PLACE_NAME, DESKTOP_REACHES, DESKTOP_AD_REQUESTS, SMART_PHONE_REACHES, SMART_PHONE_AD_REQUESTS, TABLET_REACHES, TABLET_AD_REQUESTS, UNKNOWN | |
| SortType | String | The sorting method
使用できる値は次のとおりです。ASC, DESC, UNKNOWN |
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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| Adgroupdeliverysettings | String | Ad group delivery settings | |
| AdID | Long | Ad ID | |
| AdName | String | Ad Name | |
| Adtype | String | Ad type | |
| Adtype_prev_ | String | Ad type (prev) | |
| Addeliverysettings | String | Ad delivery settings | |
| DestinationURLID | Long | Destination URL ID | |
| DestinationURL | String | Destination URL | |
| PrefectureID | String | Prefecture ID | |
| Prefectures | String | Prefectures | |
| CityID | String | City ID | |
| City | String | City | |
| WardID | String | Ward ID | |
| Ward | String | Ward | |
| Gender | String | Gender | |
| Age | String | Age | |
| Month | String | Dimension: Month | |
| Daily | String | Dimension: Daily | |
| Hourly | Long | Hourly | |
| AdDistribution | String | Ad Distribution | |
| Device | String | Device | |
| Mainmediaformat | String | Main media format | |
| MediaID | String | Media ID | |
| MediaName | String | Media Name | |
| FileName | String | File Name | |
| PixelSize | String | Pixel Size | |
| Title | String | Title | |
| Description1 | String | Description 1 | |
| Description2 | String | Description 2 | |
| DisplayURL | String | Display URL | |
| SearchKeywordID | Long | Search Keyword ID | |
| SearchKeyword | String | Search Keyword | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| Carrier | String | Carrier | |
| Layout | String | Layout | |
| DynamicImageExtensions | String | Dynamic Image Extensions | |
| CampaignlabelIDs_JSON_ | String | Campaign label IDs (JSON) | |
| Campaignlabels | String | Campaign labels | |
| Campaignlabels_JSON_ | String | Campaign labels (JSON) | |
| AdgrouplabelIDs_JSON_ | String | Ad group label IDs (JSON) | |
| Adgrouplabels | String | Ad group labels | |
| Adgrouplabels_JSON_ | String | Ad group labels (JSON) | |
| AdlabelIDs_JSON_ | String | Ad label IDs (JSON) | |
| Adlabels | String | Ad labels | |
| Adlabels_JSON_ | String | Ad labels (JSON) | |
| ConversionName | String | Conversion Name | |
| OS | String | OS | |
| Web_App | String | Web/App | |
| CampaignType | String | Campaign Type | |
| AppID_Packagename | String | App ID/Package name | |
| AppName | String | App Name | |
| AppOS | String | App OS | |
| Campaigngoals | String | Campaign goals | |
| Campaignbuyingtype | String | Campaign buying type | |
| DestinationURL_campaignbanner_ | String | Destination URL (campaign banner) | |
| Packagename | String | Package name | |
| Impressions | Long | Impressions | |
| CTR | Double | CTR | |
| Cost | Double | Cost | |
| Clicks | Long | Clicks | |
| Avg_CPC | Double | Avg. CPC | |
| Avg_position | Double | Avg. position | |
| Viewableimpressions | Long | Viewable impressions | |
| Avg_CPV | Double | Avg. CPV | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Videoviews | Long | Video views | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| Conversions | Long | Conversions | |
| Conv_rate | Double | Conv. rate | |
| Cost_conv_ | Double | Cost/conv. | |
| Conv_value | Long | Conv. value | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_vCPM | Double | Avg. vCPM | |
| Measuredimpressions | Long | Measured impressions | |
| Viewableclicks | Long | Viewable clicks | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| ViewableCTR | Double | Viewable CTR | |
| 10secvideoviews | Long | 10 sec video views | |
| Impressionshare | Double | Impression share | |
| Lostimpressionshare_budget_ | Double | Lost impression share (budget) | |
| Lostimpressionshare_rank_ | Double | Lost impression share (rank) | |
| Lifetimebudget | Long | Lifetime budget | |
| Campaigndeliverytype | String | Campaign delivery type | |
| View_throughconversions | Long | View-through conversions | |
| Videoviewthroughrate | Double | Video view through rate | |
| ConversionID | String | Conversion ID | |
| ContentkeywordID | Long | Content keyword ID | |
| Contentkeyword | String | Content keyword | |
| Conversiongroupname | String | Conversion group name | |
| ConversiongroupID | Long | Conversion group ID | |
| FinalURL | String | Final URL | |
| TrackingURL | String | Tracking URL | |
| Targetradius | String | Target radius | |
| Distancefromtargetlocation | String | Distance from target location | |
| Viewableimpressionsperpanel | Long | Viewable impressions per panel | |
| ViewableCTRperpanel | Double | Viewable CTR per panel | |
| Responsiveadstype | String | Responsive ads type |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| Month | String | Dimension: Month | |
| Daily | String | Dimension: Daily | |
| AdDistribution | String | Ad Distribution | |
| Device | String | Device | |
| Audiencecategory | String | Audience category | |
| Audiencecategorytype | String | Audience category type | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| OS | String | OS | |
| Web_App | String | Web/App | |
| CampaignType | String | Campaign Type | |
| AppID_Packagename | String | App ID/Package name | |
| AppName | String | App Name | |
| AppOS | String | App OS | |
| Campaigngoals | String | Campaign goals | |
| Campaignbuyingtype | String | Campaign buying type | |
| Packagename | String | Package name | |
| Impressions | Long | Impressions | |
| CTR | Double | CTR | |
| Cost | Double | Cost | |
| Clicks | Long | Clicks | |
| Avg_CPC | Double | Avg. CPC | |
| Avg_position | Double | Avg. position | |
| Viewableimpressions | Long | Viewable impressions | |
| Avg_CPV | Double | Avg. CPV | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Videoviews | Long | Video views | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| Conversions | Long | Conversions | |
| Conv_rate | Double | Conv. rate | |
| Cost_conv_ | Double | Cost/conv. | |
| Conv_value | Long | Conv. value | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_vCPM | Double | Avg. vCPM | |
| Measuredimpressions | Long | Measured impressions | |
| Viewableclicks | Long | Viewable clicks | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| ViewableCTR | Double | Viewable CTR | |
| 10secvideoviews | Long | 10 sec video views | |
| Lifetimebudget | Long | Lifetime budget | |
| Campaigndeliverytype | String | Campaign delivery type | |
| View_throughconversions | Long | View-through conversions | |
| Videoviewthroughrate | Double | Video view through rate | |
| ConversionID | String | Conversion ID | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| Adgroupdeliverysettings | String | Ad group delivery settings |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | Campaign for touchpoint 1 | |
| InteractionAtTouchpoint1 | String | Interaction At Touchpoint1 | |
| Touchpoint1Interactions | Long | Touchpoint 1 Interactions | |
| Accountfortouchpoint1 | String | Account for touchpoint 1 | |
| AdGroupfortouchpoint1 | String | AdGroup for touchpoint 1 | |
| Campaignfortouchpoint2 | String | Campaign for touchpoint 2 | |
| InteractionAtTouchpoint2 | String | Interaction At Touchpoint2 | |
| Touchpoint2Interactions | Long | Touchpoint 2 Interactions | |
| Accountfortouchpoint2 | String | Account for touchpoint 2 | |
| AdGroupfortouchpoint2 | String | AdGroup for touchpoint 2 | |
| Campaignfortouchpoint3 | String | Campaign for touchpoint 3 | |
| InteractionAtTouchpoint3 | String | Interaction At Touchpoint3 | |
| Touchpoint3Interactions | Long | Touchpoint 3 Interactions | |
| Accountfortouchpoint3 | String | Account for touchpoint 3 | |
| AdGroupfortouchpoint3 | String | AdGroup for touchpoint 3 | |
| Campaignfortouchpoint4 | String | Campaign for touchpoint 4 | |
| InteractionAtTouchpoint4 | String | Interaction At Touchpoint4 | |
| Touchpoint4Interactions | Long | Touchpoint 4 Interactions | |
| Accountfortouchpoint4 | String | Account for touchpoint 4 | |
| AdGroupfortouchpoint4 | String | AdGroup for touchpoint 4 | |
| Campaignfortouchpoint5 | String | Campaign for touchpoint 5 | |
| InteractionAtTouchpoint5 | String | Interaction At Touchpoint5 | |
| Touchpoint5Interactions | Long | Touchpoint 5 Interactions | |
| Accountfortouchpoint5 | String | Account for touchpoint 5 | |
| AdGroupfortouchpoint5 | String | AdGroup for touchpoint 5 | |
| Campaignfortouchpoint6 | String | Campaign for touchpoint 6 | |
| InteractionAtTouchpoint6 | String | Interaction At Touchpoint6 | |
| Touchpoint6Interactions | Long | Touchpoint 6 Interactions | |
| Accountfortouchpoint6 | String | Account for touchpoint 6 | |
| AdGroupfortouchpoint6 | String | AdGroup for touchpoint 6 | |
| Campaignfortouchpoint7 | String | Campaign for touchpoint 7 | |
| InteractionAtTouchpoint7 | String | Interaction At Touchpoint7 | |
| Touchpoint7Interactions | Long | Touchpoint 7 Interactions | |
| Accountfortouchpoint7 | String | Account for touchpoint 7 | |
| AdGroupfortouchpoint7 | String | AdGroup for touchpoint 7 | |
| Campaignfortouchpoint8 | String | Campaign for touchpoint 8 | |
| InteractionAtTouchpoint8 | String | Interaction At Touchpoint8 | |
| Touchpoint8Interactions | Long | Touchpoint 8 Interactions | |
| Accountfortouchpoint8 | String | Account for touchpoint 8 | |
| AdGroupfortouchpoint8 | String | AdGroup for touchpoint 8 | |
| Campaignfortouchpoint9 | String | Campaign for touchpoint 9 | |
| InteractionAtTouchpoint9 | String | Interaction At Touchpoint9 | |
| Touchpoint9Interactions | Long | Touchpoint 9 Interactions | |
| Accountfortouchpoint9 | String | Account for touchpoint 9 | |
| AdGroupfortouchpoint9 | String | AdGroup for touchpoint 9 | |
| Campaignfortouchpoint10 | String | Campaign for touchpoint 10 | |
| InteractionAtTouchpoint10 | String | Interaction At Touchpoint10 | |
| Touchpoint10Interactions | Long | Touchpoint 10 Interactions | |
| Accountfortouchpoint10 | String | Account for touchpoint 10 | |
| AdGroupfortouchpoint10 | String | AdGroup for touchpoint 10 | |
| Campaignfortouchpoint11 | String | Campaign for touchpoint 11 | |
| InteractionAtTouchpoint11 | String | Interaction At Touchpoint11 | |
| Touchpoint11Interactions | Long | Touchpoint 11 Interactions | |
| Accountfortouchpoint11 | String | Account for touchpoint 11 | |
| AdGroupfortouchpoint11 | String | AdGroup for touchpoint 11 | |
| Campaignfortouchpoint12 | String | Campaign for touchpoint 12 | |
| InteractionAtTouchpoint12 | String | Interaction At Touchpoint12 | |
| Touchpoint12Interactions | Long | Touchpoint 12 Interactions | |
| Accountfortouchpoint12 | String | Account for touchpoint 12 | |
| AdGroupfortouchpoint12 | String | AdGroup for touchpoint 12 | |
| Campaignfortouchpoint13 | String | Campaign for touchpoint 13 | |
| InteractionAtTouchpoint13 | String | Interaction At Touchpoint13 | |
| Touchpoint13Interactions | Long | Touchpoint 13 Interactions | |
| Accountfortouchpoint13 | String | Account for touchpoint 13 | |
| AdGroupfortouchpoint13 | String | AdGroup for touchpoint 13 | |
| Campaignfortouchpoint14 | String | Campaign for touchpoint 14 | |
| InteractionAtTouchpoint14 | String | Interaction At Touchpoint14 | |
| Touchpoint14Interactions | Long | Touchpoint 14 Interactions | |
| Accountfortouchpoint14 | String | Account for touchpoint 14 | |
| AdGroupfortouchpoint14 | String | AdGroup for touchpoint 14 | |
| Campaignfortouchpoint15 | String | Campaign for touchpoint 15 | |
| InteractionAtTouchpoint15 | String | Interaction At Touchpoint15 | |
| Touchpoint15Interactions | Long | Touchpoint 15 Interactions | |
| Accountfortouchpoint15 | String | Account for touchpoint 15 | |
| AdGroupfortouchpoint15 | String | AdGroup for touchpoint 15 | |
| Campaignfortouchpoint16 | String | Campaign for touchpoint 16 | |
| InteractionAtTouchpoint16 | String | Interaction At Touchpoint16 | |
| Touchpoint16Interactions | Long | Touchpoint 16 Interactions | |
| Accountfortouchpoint16 | String | Account for touchpoint 16 | |
| AdGroupfortouchpoint16 | String | AdGroup for touchpoint 16 | |
| Campaignfortouchpoint17 | String | Campaign for touchpoint 17 | |
| InteractionAtTouchpoint17 | String | Interaction At Touchpoint17 | |
| Touchpoint17Interactions | Long | Touchpoint 17 Interactions | |
| Accountfortouchpoint17 | String | Account for touchpoint 17 | |
| AdGroupfortouchpoint17 | String | AdGroup for touchpoint 17 | |
| Campaignfortouchpoint18 | String | Campaign for touchpoint 18 | |
| InteractionAtTouchpoint18 | String | Interaction At Touchpoint18 | |
| Touchpoint18Interactions | Long | Touchpoint 18 Interactions | |
| Accountfortouchpoint18 | String | Account for touchpoint 18 | |
| AdGroupfortouchpoint18 | String | AdGroup for touchpoint 18 | |
| Campaignfortouchpoint19 | String | Campaign for touchpoint 19 | |
| InteractionAtTouchpoint19 | String | Interaction At Touchpoint19 | |
| Touchpoint19Interactions | Long | Touchpoint 19 Interactions | |
| Accountfortouchpoint19 | String | Account for touchpoint 19 | |
| AdGroupfortouchpoint19 | String | AdGroup for touchpoint 19 | |
| Campaignfortouchpoint20 | String | Campaign for touchpoint 20 | |
| InteractionAtTouchpoint20 | String | Interaction At Touchpoint20 | |
| Touchpoint20Interactions | Long | Touchpoint 20 Interactions | |
| Accountfortouchpoint20 | String | Account for touchpoint 20 | |
| AdGroupfortouchpoint20 | String | AdGroup for touchpoint 20 | |
| Conversions_incl_view_through_ | Long | Conversions (incl. view-through) | |
| Conv_value_incl_view_through_ | Long | Conv. value (incl. view-through) | |
| Conversions | Long | Conversions | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| View_throughconversions | Long | View-through conversions | |
| AccountId | Long | Account Id |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | Campaign | |
| Uniqueuserswithviewableimpressions | Long | Unique users with viewable impressions | |
| Uniqueuserswithclicksorvideoviews | Long | Unique users with clicks or video views | |
| Uniqueuserswithconversions_incl_view_through_ | Long | Unique users with conversions (incl. view-through) | |
| Uniqueuserswithconversions | Long | Unique users with conversions | |
| Uniqueuserswithconversions_viaclick_ | Long | Unique users with conversions (via click) | |
| Uniqueuserswithview_throughconversions | Long | Unique users with view-through conversions | |
| Account | String | Account | |
| AccountId | Long | Account Id |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end date. | |
| CrossCampaignType | String | Indicates the combination type of Cross-campaign Reach Report. | |
| CrossCampaignId | String | Indicates account and campaign ID that is subject to Cross-campaign Reach Report combination. | |
| CrossCampaignGoal | String | Indicates account and campaign goal that is subject to Cross-campaign Reach Report combination. |
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 | Dimension: Month | |
| Daily | String | Dimension: Daily | |
| Hourly | Long | Hourly | |
| CampaignlabelID | Long | Campaign label ID | |
| Campaignlabel | String | Campaign label | |
| AdgrouplabelID | Long | Ad group label ID | |
| Adgrouplabel | String | Ad group label | |
| AdlabelID | Long | Ad label ID | |
| Adlabel | String | Ad label | |
| Impressions | Long | Impressions | |
| CTR | Double | CTR | |
| Cost | Double | Cost | |
| Clicks | Long | Clicks | |
| Avg_CPC | Double | Avg. CPC | |
| Avg_position | Double | Avg. position | |
| Viewableimpressions | Long | Viewable impressions | |
| Avg_CPV | Double | Avg. CPV | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Videoviews | Long | Video views | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| Conversions | Long | Conversions | |
| Conv_rate | Double | Conv. rate | |
| Cost_conv_ | Double | Cost/conv. | |
| Conv_value | Long | Conv. value | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_vCPM | Double | Avg. vCPM | |
| Measuredimpressions | Long | Measured impressions | |
| Viewableclicks | Long | Viewable clicks | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| ViewableCTR | Double | Viewable CTR | |
| 10secvideoviews | Long | 10 sec video views | |
| View_throughconversions | Long | View-through conversions | |
| Videoviewthroughrate | Double | Video view through rate | |
| AccountId | Long | Account Id |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | Placement list ID | |
| Placementlistname | String | Placement list name | |
| AccountId | Long | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| Campaignbuyingtype | String | Campaign buying type | |
| Campaigndeliverytype | String | Campaign delivery type | |
| Campaigngoals | String | Campaign goals | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| Device | String | Device | |
| OS | String | OS | |
| Web_App | String | Web/App | |
| Avg_position | Double | Avg. position | |
| Conv_rate | Double | Conv. rate | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Avg_CPC | Double | Avg. CPC | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Clicks | Long | Clicks | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Cost_conv_ | Double | Cost/conv. | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Cost | Double | Cost | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| 10secvideoviews | Long | 10 sec video views | |
| Avg_CPV | Double | Avg. CPV | |
| Videoviews | Long | Video views | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Viewableimpressions | Long | Viewable impressions | |
| Avg_vCPM | Double | Avg. vCPM | |
| View_throughconversions | Long | View-through conversions | |
| Impressions | Long | Impressions | |
| Avg_CPM | Double | Avg. CPM | |
| CTR | Double | CTR | |
| Measuredimpressions | Long | Measured impressions | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| Viewableclicks | Long | Viewable clicks | |
| ViewableCTR | Double | Viewable CTR | |
| Daily | String | Dimension: Daily | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conversions | Long | Conversions | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value | Long | Conv. value | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| AppID_Packagename | String | App ID/Package name | |
| AppName | String | App Name | |
| AppOS | String | App OS | |
| AdDeliveryURL | String | Ad Delivery URL | |
| Videoviewthroughrate | Double | Video view through rate | |
| Month | String | Dimension: Month | |
| ConversionID | String | Conversion ID | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| Adgroupdeliverysettings | String | Ad group delivery settings |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| AdID | Long | Ad ID | |
| AdName | String | Ad Name | |
| Daily | String | Dimension: Daily | |
| Campaigngoals | String | Campaign goals | |
| Campaignbuyingtype | String | Campaign buying type | |
| Packagename | String | Package name | |
| Impressions | Long | Impressions | |
| CTR | Double | CTR | |
| Cost | Double | Cost | |
| Clicks | Long | Clicks | |
| Avg_CPC | Double | Avg. CPC | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_vCPM | Double | Avg. vCPM | |
| Viewableimpressions | Long | Viewable impressions | |
| Measuredimpressions | Long | Measured impressions | |
| Viewableclicks | Long | Viewable clicks | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| ViewableCTR | Double | Viewable CTR | |
| Avg_CPV | Double | Avg. CPV | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Videoviews | Long | Video views | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| 10secvideoviews | Long | 10 sec video views | |
| Conversions | Long | Conversions | |
| Conv_rate | Double | Conv. rate | |
| Cost_conv_ | Double | Cost/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Reaches | Long | Reaches | |
| Averagefrequency | Double | Average frequency | |
| Startdate | String | Start date | |
| Enddate | String | End date | |
| Lifetimebudget | Long | Lifetime budget | |
| Campaigndeliverytype | String | Campaign delivery type | |
| View_throughconversions | Long | View-through conversions | |
| Videoviewthroughrate | Double | Video view through rate | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| Adgroupdeliverysettings | String | Ad group delivery settings | |
| Addeliverysettings | String | Ad delivery settings | |
| Reaches_viewableimpression_ | Long | Reaches (viewable impression) | |
| Averagefrequency_viewableimpression_ | Double | Average frequency (viewable impression) | |
| Reaches_measuredimpression_ | Long | Reaches (measured impression) | |
| Averagefrequency_measuredimpression_ | Double | Average frequency (measured impression) |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| AppID_Packagename | String | App ID/Package name | |
| AppName | String | App Name | |
| AppOS | String | App OS | |
| Web_App | String | Web/App | |
| Avg_CPC | Double | Avg. CPC | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_CPV | Double | Avg. CPV | |
| Avg_position | Double | Avg. position | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_vCPM | Double | Avg. vCPM | |
| Campaignbuyingtype | String | Campaign buying type | |
| Campaigngoals | String | Campaign goals | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Conv_rate | Double | Conv. rate | |
| Conv_value | Long | Conv. value | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| View_throughconversions | Long | View-through conversions | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Conversions | Long | Conversions | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Cost | Double | Cost | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Cost_conv_ | Double | Cost/conv. | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Daily | String | Dimension: Daily | |
| Device | String | Device | |
| Impressions | Long | Impressions | |
| Month | String | Dimension: Month | |
| Measuredimpressions | Long | Measured impressions | |
| Measuredimpressionrate | Double | Measured impression rate | |
| OS | String | OS | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| SearchkeywordlistID | Long | Search keyword list ID | |
| Searchkeywordlistname | String | Search keyword list name | |
| Campaigndeliverytype | String | Campaign delivery type | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Videoviews | Long | Video views | |
| 3secvideoviews | Long | 3 sec video views | |
| 10secvideoviews | Long | 10 sec video views | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Viewableclicks | Long | Viewable clicks | |
| ViewableCTR | Double | Viewable CTR | |
| Viewableimpressions | Long | Viewable impressions | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| Videoviewthroughrate | Double | Video view through rate | |
| ConversionID | String | Conversion ID | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| Adgroupdeliverysettings | String | Ad group delivery settings |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| Month | String | Dimension: Month | |
| Daily | String | Dimension: Daily | |
| AdDistribution | String | Ad Distribution | |
| Device | String | Device | |
| SiteCategory | String | Site Category | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| Carrier | String | Carrier | |
| ConversionName | String | Conversion Name | |
| OS | String | OS | |
| Web_App | String | Web/App | |
| CampaignType | String | Campaign Type | |
| AppID_Packagename | String | App ID/Package name | |
| AppName | String | App Name | |
| AppOS | String | App OS | |
| Campaigngoals | String | Campaign goals | |
| Campaignbuyingtype | String | Campaign buying type | |
| Impressions | Long | Impressions | |
| CTR | Double | CTR | |
| Cost | Double | Cost | |
| Clicks | Long | Clicks | |
| Avg_CPC | Double | Avg. CPC | |
| Avg_position | Double | Avg. position | |
| Viewableimpressions | Long | Viewable impressions | |
| Avg_CPV | Double | Avg. CPV | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Videoviews | Long | Video views | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| Conversions | Long | Conversions | |
| Conv_rate | Double | Conv. rate | |
| Cost_conv_ | Double | Cost/conv. | |
| Conv_value | Long | Conv. value | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_vCPM | Double | Avg. vCPM | |
| Measuredimpressions | Long | Measured impressions | |
| Viewableclicks | Long | Viewable clicks | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| ViewableCTR | Double | Viewable CTR | |
| 10secvideoviews | Long | 10 sec video views | |
| Campaigndeliverytype | String | Campaign delivery type | |
| View_throughconversions | Long | View-through conversions | |
| Videoviewthroughrate | Double | Video view through rate | |
| ConversionID | String | Conversion ID | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| Adgroupdeliverysettings | String | Ad group delivery settings |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | Campaign ID | |
| CampaignName | String | Campaign Name | |
| AdGroupID | Long | Ad Group ID | |
| AdGroupName | String | Ad Group Name | |
| Daily | String | Dimension: Daily | |
| AdDistribution | String | Ad Distribution | |
| Device | String | Device | |
| AdDeliveryURL | String | Ad Delivery URL | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| Carrier | String | Carrier | |
| ConversionName | String | Conversion Name | |
| OS | String | OS | |
| Web_App | String | Web/App | |
| Campaigngoals | String | Campaign goals | |
| Campaignbuyingtype | String | Campaign buying type | |
| Packagename | String | Package name | |
| Impressions | Long | Impressions | |
| CTR | Double | CTR | |
| Cost | Double | Cost | |
| Clicks | Long | Clicks | |
| Avg_CPC | Double | Avg. CPC | |
| Viewableimpressions | Long | Viewable impressions | |
| Avg_CPV | Double | Avg. CPV | |
| 25_videoviews | Long | 25% video views | |
| 50_videoviews | Long | 50% video views | |
| 75_videoviews | Long | 75% video views | |
| 95_videoviews | Long | 95% video views | |
| 100_videoviews | Long | 100% video views | |
| Avg_videoviewrate | Double | Avg. video view rate | |
| Avg_durationofvideoviewed | Double | Avg. duration of video viewed | |
| Conversions | Long | Conversions | |
| Conv_rate | Double | Conv. rate | |
| Cost_conv_ | Double | Cost/conv. | |
| Videoviews | Long | Video views | |
| Paidvideoviews_CPV_ | Long | Paid video views (CPV) | |
| Paidvideoviewrate_CPV_ | Double | Paid video view rate (CPV) | |
| 3secvideoviews | Long | 3 sec video views | |
| Conv_value | Long | Conv. value | |
| Conv_value_conv_ | Double | Conv. value/conv. | |
| Conversions_all_ | Long | Conversions (all) | |
| Conv_rate_all_ | Double | Conv. rate (all) | |
| Cost_conv_all_ | Double | Cost/conv. (all) | |
| Conv_value_all_ | Long | Conv. value (all) | |
| Conv_value_all_conv_all_ | Double | Conv. value (all)/conv. (all) | |
| Conversions_viaclick_ | Long | Conversions (via click) | |
| Conv_rate_viaclick_ | Double | Conv. rate (via click) | |
| Cost_conv_viaclick_ | Double | Cost/conv. (via click) | |
| Conv_value_viaclick_ | Long | Conv. value (via click) | |
| Conv_value_viaclick_conv_viaclick_ | Double | Conv. value (via click)/conv. (via click) | |
| Cross_deviceconv_ | Long | Cross-device conv. | |
| Conv_value_cost | Double | Conv. value/cost | |
| Conv_value_all_cost | Double | Conv. value (all)/cost | |
| Conv_value_viaclick_cost | Double | Conv. value (via click)/cost | |
| Avg_CPM | Double | Avg. CPM | |
| Avg_vCPM | Double | Avg. vCPM | |
| Measuredimpressions | Long | Measured impressions | |
| Viewableclicks | Long | Viewable clicks | |
| Measuredimpressionrate | Double | Measured impression rate | |
| Viewableimpressionrate | Double | Viewable impression rate | |
| ViewableCTR | Double | Viewable CTR | |
| 10secvideoviews | Long | 10 sec video views | |
| Lifetimebudget | Long | Lifetime budget | |
| Campaigndeliverytype | String | Campaign delivery type | |
| View_throughconversions | Long | View-through conversions | |
| Videoviewthroughrate | Double | Video view through rate | |
| ConversionID | String | Conversion ID | |
| Campaigndeliverysettings | String | Campaign delivery settings | |
| Adgroupdeliverysettings | String | Ad group delivery settings | |
| Avg_position | Double | Avg. position | |
| AppID_Packagename | String | App ID/Package name | |
| AppName | String | App Name | |
| AppOS | String | App OS | |
| Month | String | Dimension: Month |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 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 |
Obtain stats for 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, DEFINITE_VALUE_MONTH, 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_RANGE18_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, 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, 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. |
ストアドプロシージャはファンクションライクなインターフェースで、Yahoo! Ads の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにYahoo! Ads から関連するレスポンスデータを返します。
| Name | Description |
| DisplayAdsAddAdGroupAdLabels | To create DisplayAds AdGroupAd Labels. |
| DisplayAdsAddAdGroupLabels | To create DisplayAds AdGroup Labels. |
| DisplayAdsAddCampaignLabels | To create DisplayAds Campaign Labels. |
| DisplayAdsCreateFeedFtpRequest | Create registered FTP setting information. |
| DisplayAdsRemoveAdGroupAdLabels | To remove DisplayAds AdGroupAd Labels. |
| DisplayAdsRemoveAdGroupLabels | To remove DisplayAds AdGroup Labels. |
| DisplayAdsRemoveCampaignLabels | To remove DisplayAds Campaign Labels. |
Creates a schema file for the specified table or view.
データモデル内の既存のテーブルまたはビューからローカルスキーマファイル(.rsd)を作成します。
スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。
Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリがSync App のデータモデルに追加されます。
| Name | Type | Description |
| TableName | String | The name of the table or view. |
| FileName | String | The full file path and name of the schema to generate. Ex : 'C:\\Users\\User\\Desktop\\SmartSheet\\sheet.rsd' |
| Name | Type | Description |
| FileData | String | If the FileName and FileStream are not provided, this contains the content of the file. |
| Result | String | Returns Success or Failure. |
To create DisplayAds AdGroupAd Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsAddAdGroupAdLabels are AccountId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE DisplayAdsAddAdGroupAdLabels AccountId = '1002504155', AdId = '84562', AdGroupId = '512345', CampaignId = '31344165', LabelId = '1000191827'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from DisplayAdsAccounts.AccountId |
| AdId | Int64 | Ad group Ad ID. Values can be Referred from DisplayAdsAdGroupAds.AdId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from DisplayAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from DisplayAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from DisplayAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To create DisplayAds AdGroup Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsAddAdGroupLabels are AccountId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE DisplayAdsAddAdGroupLabels AccountId = '1002504155', AdGroupId = '512345', CampaignId = '31344165', LabelId = '1000191827'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from DisplayAdsAccounts.AccountId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from DisplayAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from DisplayAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from DisplayAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To create DisplayAds Campaign Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsAddCampaignLabels are AccountId, CampaignId and LabelId.
For example:
EXECUTE DisplayAdsAddCampaignLabels AccountId = '1002504155', CampaignId = '31344165', LabelId = '1000191827'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from DisplayAdsAccounts.AccountId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from DisplayAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from DisplayAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Create registered FTP setting information.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in CreateFeedFtpRequest are AccountId and FeedId.
For example:
EXECUTE DisplayAdsCreateFeedFtpRequest AccountId = '123436', FeedId = '25334'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| FeedId | Int64 | Feed ID. |
| Name | Type | Description |
| Status | String | True if Feed Id is registered. |
Download the uploaded original csv file as well as error files.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DownloadCampaignMigrationOriginalFileAndErrorFile are AccountId,MigrationJobId and DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadCampaignMigrationErrorFile AccountId = '8976', MigrationJobId = '8936', DownloadLocation = 'C:/DownloadCampaignMigrationErrorFile.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| MigrationJobId | Int64 | Migration Job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Name | Type | Description |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
| Status | String | Execution status of the stored procedure |
Download the list of campaigns targeted for migration.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DownloadCampaignMigrationList are AccountId, Lang and DownloadLocation
For example:
EXECUTE DisplayAdsDownloadCampaignMigrationList AccountId = '8976', Lang = 'JA', DownloadLocation = 'C:/DownloadCampaignMigrationList.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| Lang | String | Language of the migration process.
使用できる値は次のとおりです。JA, EN, UNKNOWN |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Name | Type | Description |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
| Status | String | Execution status of the stored procedure |
Download the uploaded original csv file as well as error files.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DownloadCampaignMigrationOriginalFileAndErrorFile are AccountId, MigrationJobId and DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadCampaignMigrationOriginalFile AccountId = '8976', MigrationJobId = '8936', DownloadLocation = 'C:\DownloadCampaignMigrationOriginalFile.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| MigrationJobId | Int64 | Migration Job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Name | Type | Description |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
| Status | String | Execution status of the stored procedure |
Downloads feed data error file.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DownloadFeedDataErrorFile are AccountId, ItemListUploadId, DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadFeedDataErrorFile AccountId = '8976', ItemListUploadId = '8936', DownloadLocation = 'C:/DownloadFeedDataErrorFile.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| ItemListUploadId | Int64 | Uploaded item list ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Downloads the disapproval reason list.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DownloadFeedDisApprovalReasonList are AccountId, FeedId, DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadFeedDisApprovalReasonList AccountId = '8976', FeedId = '8914', DownloadLocation = 'C:/DownloadFeedDisApprovalReasonList.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| FeedId | Int64 | Uploaded item list ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download the submitted media file.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsDownloadMedia are AccountId, MediaId and DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadMedia AccountId = '1234', MediaId = '9826', DownloadLocation = 'C:/DownloadMedia.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| MediaId | Int64 | Media ID. |
| DownloadLocation | String | Download location. For example: C:\Report.mp4 |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download offline conversion error files.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsDownloadOfflineConversionErrorFile are AccountId, UploadId AND DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadOfflineConversionErrorFile AccountId = '1002504155', UploadId = '9890', DownloadLocation = 'D:\\Desktop\\file.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| UploadId | Int64 | Upload ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download the DisplayAds report.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsDownloadReport are AccountId,ReportJobId.
For example:
EXECUTE DisplayAdsDownloadReport AccountId='8976', ReportJobId='25334', DownloadLocation='C:\Report.csv'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| ReportJobId | Int64 | Report Job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Download the data of user operation history.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsDownloadUserOperationHistory are AccountId, AuditLogJobId and DownloadLocation.
For example:
EXECUTE DisplayAdsDownloadUserOperationHistory AccountId = '8976', AuditLogJobId='58971', DownloadLocation='C:/DisplayAdsDownloadUserOperationHistory.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| AuditLogJobId | Int64 | The operation history job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download the added video.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DownloadVideo are AccountId, MediaId, QualityType and DownloadVideo
For example:
EXECUTE DisplayAdsDownloadVideo AccountId = '1234', MediaId = '9826', QualityType = 'ORIGINAL', DownloadLocation = 'C:/DownloadVideo.mp4'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| MediaId | Int64 | Media ID. |
| QualityType | String | VideoServiceQualityType. |
| DownloadLocation | String | Download location. For example: C:\Report.mp4 |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
To remove DisplayAds AdGroupAd Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsRemoveAdGroupAdLabels are AccountId, AdId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE DisplayAdsRemoveAdGroupAdLabels AccountId = '1002504155', AdId = '21364', AdGroupId = '512345', CampaignId = '31344165', LabelId = '1000191827'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from DisplayAdsAccounts.AccountId |
| AdId | Int64 | Ad group Ad ID. Values can be Referred from DisplayAdsAdGroupAds.AdId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from DisplayAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from DisplayAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from DisplayAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To remove DisplayAds AdGroup Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsRemoveAdGroupAdLabels are AccountId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE DisplayAdsRemoveAdGroupLabels AccountId = '1002504155', AdGroupId = '512345', CampaignId = '31344165', LabelId = '1000191827'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from DisplayAdsAccounts.AccountId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from DisplayAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from DisplayAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from DisplayAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To remove DisplayAds Campaign Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsRemoveCampaignLabels are AccountId, CampaignId and LabelId.
For example:
EXECUTE DisplayAdsRemoveCampaignLabels AccountId = '1002504155', CampaignId = '31344165', LabelId = '1000191827'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from DisplayAdsAccounts.AccountId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from DisplayAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from DisplayAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Upload csv files for migration.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsUploadCampaignMigrationList are AccountId and FileLocation.
For example:
EXECUTE DisplayAdsUploadCampaignMigrationList AccountId = '8976', FileLocation = 'C:/UploadCampaignMigrationList.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| FileLocation | String | File to upload. |
| FileName | String | Name of the file to be uploaded only when content is given. For example: test.csv |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Executes upload item list.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsUploadFeedData are AccountId, FeedId, UploadType, IsDebug and FileLocation.
For example:
EXECUTE DisplayAdsUploadFeedData AccountId = '897653', FeedId = '25334', UploadType = 'UPDATE_PART', IsDebug = 'True', FileLocation = 'C:/UploadFeedData.txt'
| Name | Type | Description |
| AccountId | String | Account ID. |
| FeedId | String | Feed ID. |
| UploadType | String | Displays upload type of item list.
使用できる値は次のとおりです。UPDATE_PART, UPDATE_ALL, UNKNOWN |
| IsDebug | String | True means to run in debug mode. |
| FileName | String | Name of the file to be uploaded. |
| FileLocation | String | Location of the file to upload. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Execute upload offline conversion data.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsUploadOfflineConversion are AccountId, UploadFileName AND FileLocation.
For example:
EXECUTE DisplayAdsUploadOfflineConversion AccountId = '1002504155', UploadFileName = 'abc.txt', FileLocation = 'D:\\Desktop\\abc.txt'
| Name | Type | Description |
| AccountId | String | Account ID. |
| UploadFileName | String | Name of the file to be uploaded. |
| FileLocation | String | Location of the file to upload. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Upload the user list file for audience list (custom) and audience list (customer data).
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsUploadUserList are AccountId, RetargetingTagId, TargetListId, UploadType and CompressType.
For example:
EXECUTE DisplayAdsUploadUserList AccountId = '8976', RetargetingTagId = '89746', AudienceListId = '56638', UploadType = 'IDFA', CompressType = 'ZIP'
| Name | Type | Description |
| AccountId | Int64 | AccountId |
| AudienceListId | Int64 | Audience list ID. |
| UploadType | String | AudienceListServiceUploadUserListUploadType displays kind of upload method.
使用できる値は次のとおりです。IDFA, AAID, MAIL_ADDRESS_AND_PHONE_NUMBER, UNKNOWN |
| CompressType | String | Displays kind of compress type of upload file.
使用できる値は次のとおりです。NONE, ZIP, GZIP, UNKNOWN |
| FileName | String | Name of the file to be uploaded only when content is given. For example: test.csv |
| FileLocation | String | Locatipn of the file to upload. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| UploadJobId | String | Upload job ID. |
Upload process of video files can be operated.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in DisplayAdsUploadVideo are AccountId,VideoName,VideoTitle,UserStatus and FileLocation.
For example:
EXECUTE DisplayAdsUploadVideo AccountId = '8976', VideoName = 'DEMO', VideoTitle = 'Yahoosearchads', UserStatus = 'ACTIVE', FileLocation = 'c:/UploadVideo.mp4'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| VideoName | String | Video file name. |
| VideoTitle | String | Video name. |
| UserStatus | String | Serves ad delivery status that can be set by an user.
使用できる値は次のとおりです。ACTIVE, PAUSED, UNKNOWN |
| FileLocation | String | File to upload. |
| FileName | String | Name of the file to be uploaded only when content is given. For example: test.csv |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Gets an authentication token from Yahoo! Ads.
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Scope | String | A comma-separated list of permissions to request from the user. Please check the Yahoo Ads API for a list of available permissions.
デフォルト値はyahooadsです。 |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Yahoo! Ads app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | The verifier returned from Yahoo! Ads after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Yahoo! Ads authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Yahoo! Ads. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Yahoo! Ads. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Description |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Yahoo! Ads app settings. |
| Scope | String | A comma-separated list of scopes to request from the user. Please check the Yahoo! Ads API documentation for a list of available permissions.
デフォルト値はyahooadsです。 |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Yahoo! Ads authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with Yahoo! Ads.
| Name | Type | Description |
| OAuthRefreshToken | String | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Yahoo! Ads. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
このセクションでは、利用可能な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 | Retrieve, 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. |
| SearchAdsAbTest | Create, Read, Update and Remove A/B test information. |
| 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. |
| SearchAdsConversionGroups | Get ConversionGroup information of specified account |
| 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. |
| SsaReportDefinition | Create, Read, Update and Remove SSA report definition information for Search Ads. |
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. 使用できる値は次のとおりです。QUICKLINK, CALL, CALLOUT, STRUCTURED_SNIPPET, IMAGE, UNKNOWN | |
| 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 |
Retrieve, 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'
Delete can be executed by specifying the AccountId and AssetId in the WHERE Clause.
For example:
DELETE FROM Asset WHERE AccountId = '1234339' AND AssetId = '25683';
| 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. 使用できる値は次のとおりです。QUICKLINK, CALL, CALLOUT, STRUCTURED_SNIPPET, IMAGE, FAVICON, UNKNOWN | |
| 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. | |
| AssetDataImageAssetImageName | String | True |
Image name. | |
| AssetDataImageAssetAspectRatio | String | True |
The type of aspect ratio. | |
| AssetDataImageAssetFileSize | Int64 | True |
The file size of image. | |
| AssetDataImageAssetHeight | Int64 | True |
The height of image. | |
| AssetDataImageAssetWidth | Int64 | True |
The width of image. | |
| AssetDataImageAssetFileType | String | True |
The file type of image. 使用できる値は次のとおりです。PNG, JPEG, UNKNOWN | |
| AssetDataFaviconAssetFaviconName | String | True |
Favicon name. | |
| AssetDataFaviconAssetAspectRatio | String | True |
The type of aspect ratio. | |
| AssetDataFaviconAssetFileSize | Int64 | True |
The file size of Favicon. | |
| AssetDataFaviconAssetHeight | Int64 | True |
The height of Favicon. | |
| AssetDataFaviconAssetWidth | Int64 | True |
The width of Favicon. | |
| AssetDataFaviconAssetFileType | String | True |
The file type of Favicon. 使用できる値は次のとおりです。PNG, JPEG, UNKNOWN |
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' SELECT * FROM BiddingSeasonalityAdjustment WHERE CampaignIds = '1230749'
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. 使用できる値は次のとおりです。QUICKLINK, CALL, CALLOUT, STRUCTURED_SNIPPET, IMAGE, UNKNOWN | |
| 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,ASSET,QUICKLINK_ASSET,CALLOUT_ASSET,STRUCTURED_SNIPPET_ASSET,CALLEXTENSION_ASSET,IMAGE_ASSET,ALL,FAVICON_ASSET,UNKNOWN 使用できる値は次のとおりです。CAMPAIGN, NEGATIVE_CAMPAIGN_CRITERION, AD_GROUP, BIDDABLE_AD_GROUP_CRITERION, NEGATIVE_AD_GROUP_CRITERION, AD, ASSET, QUICKLINK_ASSET, CALLOUT_ASSET, STRUCTURED_SNIPPET_ASSET, CALLEXTENSION_ASSET, IMAGE_ASSET, 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, Read, Update and Remove A/B test information.
| Name | Type | ReadOnly | References | Description |
| AbTestId [KEY] | Int64 | False |
A/B test ID. | |
| AbTestName | String | False |
A/B test name. | |
| AccountId | Int64 | False |
SearchAdsAccounts.AccountId |
Account Id. |
| 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. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKOWN | |
| ACampaignTestType | String | False |
It describes the test type of campaign A. 使用できる値は次のとおりです。BASE, TEST, NONE, UNKOWN | |
| ACampaignIsDeleted | String | False |
If the campaign A is deleted. 使用できる値は次のとおりです。TRUE, FALSE, UNKOWN | |
| 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 B. 使用できる値は次のとおりです。ACTIVE, PAUSED, UNKOWN | |
| BCampaignTestType | String | False |
It describes the test type of campaign B. 使用できる値は次のとおりです。BASE, TEST, NONE, UNKOWN | |
| BCampaignIsDeleted | String | False |
If the campaign B is deleted. 使用できる値は次のとおりです。TRUE, FALSE, UNKOWN | |
| Description | String | False |
Description text. | |
| Suffix | String | False |
Suffix text. | |
| EndDate | Date | False |
End date. | |
| IsRemoveDescription | String | False |
It is a flag for removing an information item. 使用できる値は次のとおりです。TRUE, FALSE, UNKOWN | |
| StartDate | Date | False |
Start date. | |
| Status | String | False |
It shows AbTestServiceStatus status. 使用できる値は次のとおりです。PENDING, ACTIVE, ENDED, GRADUATED, ERROR, UNKNOWN |
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 CreatedStartDate = '2021-02-15' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND CreatedEndDate = '2021-06-03' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND UpdatedStartDate = '2021-02-15' SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND UpdatedEndDate = '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 |
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. |
| CreatedStartDate | Date |
This is the start date of the search target period by the creation date. |
| CreatedEndDate | Date |
This is the end date of the search target period by the creation date. |
| UpdatedStartDate | Date |
This is the start date of the search target period by the update date. |
| UpdatedEndDate | Date |
This is the end date of the search target period by the update date. |
| 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. |
| CreatedStartDate | Date |
This is the start date of the search target period by the creation date. |
| CreatedEndDate | Date |
This is the end date of the search target period by the creation date. |
| UpdatedStartDate | Date |
This is the start date of the search target period by the update date. |
| UpdatedEndDate | Date |
This is the end date of the search target period by the update date. |
| 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' SELECT * FROM SearchAdsCampaigns WHERE AccountId = '12346' AND UpdatedStartDate = '2021-01-21' AND UpdatedEndDate = '2021-02-03'
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. |
| UpdatedStartDate | Date |
This is the start date of the search target period by the update date. |
| UpdatedEndDate | Date |
This is the end date of the search target period by the update date. |
Get ConversionGroup information of specified account
| Name | Type | ReadOnly | References | Description |
| ConversionGroupId [KEY] | Int64 | True |
Conversion Group ID.This field will be ignored in ADD operation, and will be required in SET and REMOVE operation | |
| AccountId | Int64 | False |
SearchAdsAccounts.AccountId |
Account ID. |
| ConversionGroupName | String | False |
Conversion Group Name.This field is required in ADD operation, and will be optional in SET operation | |
| ConversionTrackers | String | False |
An array of conversion tracker id integers. |
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, 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. |
Create, Read, Update and Remove SSA report definition information for Search Ads.
| Name | Type | ReadOnly | References | Description |
| ReportJobId [KEY] | Int64 | True |
Report Job ID. Unique identifier for the report job. | |
| ReportName | String | False |
Report name. User-defined name for the report. | |
| ReportJobStatus | String | False |
Report job status. Current status of the report processing job. 使用できる値は次のとおりです。WAIT, COMPLETED, IN_PROGRESS, FAILED, UNKNOWN | |
| ReportLanguage | String | False |
Report language. Language setting for the report output. 使用できる値は次のとおりです。JA, EN, UNKNOWN | |
| AccountId | Int64 | False |
SearchAdsAccounts.AccountId |
Account ID. The account ID associated with the report definition. |
| CompleteTime | Datetime | False |
Complete time. The date and time when the report job was completed. | |
| RequestTime | Datetime | False |
Request time. The date and time when the report job was requested. | |
| StartDate | Date | False |
Start date. The start date of the report period. | |
| EndDate | Date | False |
End date. The end date of the report period. | |
| Fields | String | False |
Fields. Comma-separated list of fields to include in the report. | |
| Filters | String | False |
Filters. Filtering conditions to apply to the report data. | |
| ReportCompressType | String | False |
Report compress type. Compression format for the report file. 使用できる値は次のとおりです。NONE, UNKNOWN | |
| ReportDateRangeType | String | False |
Report date range type. Predefined date range type for the report period. 使用できる値は次のとおりです。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, UNKNOWN | |
| ReportDecimalPartDisplayType | String | False |
Report decimal part display type. Display format for decimal values in the report. 使用できる値は次のとおりです。FULL_DISPLAY, SIMPLE_DISPLAY, UNKNOWN | |
| ReportDownloadEncode | String | False |
Report download encode. Character encoding format for the report file. 使用できる値は次のとおりです。UTF8, UNKNOWN | |
| ReportDownloadFormat | String | False |
Report download format. File format for the report download. 使用できる値は次のとおりです。CSV, XML, TSV, UNKNOWN | |
| ReportJobErrorDetail | String | False |
Report job error detail. Details of any errors that occurred during report processing. | |
| ReportSkipColumnHeader | String | False |
Report skip column header. Whether to skip column headers in the report output. | |
| ReportSkipReportSummary | String | False |
Report skip report summary. Whether to skip the report summary section in the report output. | |
| ReportType | String | False |
Report type. The type of report to generate (e.g., ACCOUNT, CAMPAIGN, ADGROUP, etc.). | |
| SortFields | String | False |
Sort fields. Fields and sort order for organizing the report data. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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 |
| 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 |
| ReportSearchAdsAsset_combinations | To view the Asset Combination report, a simple SELECT statement generates and retrieves the report for the last 7 days. |
| 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. |
| 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 |
| SsaAccounts | Read SSA account information for Search Ads. |
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 |
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 | AccountId | |
| AccountName | String | Account Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| InvalidClicks | Long | Invalid Clicks | |
| InvalidClickRate | Double | Invalid Click Rate | |
| ImpressionShare | Double | Impression Share | |
| ExactMatchImpressionShare | Double | Exact Match Impression Share | |
| BudgetLostImpressionShare | Double | Budget Lost Impression Share | |
| QualityLostImpressionShare | Double | Quality Lost Impression Share | |
| TrackingURL | String | Tracking URL | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| Showadson | String | Show ads on | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| Hourofday | Long | Hour of day | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| AdID | Long | Ad ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| AdName | String | Ad Name | |
| DisplayURL | String | Display URL | |
| DestinationURL | String | Destination URL | |
| AdType | String | Ad Type | |
| DistributionSettings | String | Distribution Settings | |
| EditorialStatus | String | Editorial Status | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| Description1 | String | Description 1 | |
| Description2 | String | Description 2 | |
| FocusDevice | String | Focus Device | |
| TrackingURL | String | Tracking URL | |
| CustomParameters | String | Custom Parameters | |
| FinalURL | String | Final URL | |
| SmartphonefinalURL | String | Smartphone final URL | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdTrackingID | Long | Ad Tracking ID | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| Showadson | String | Show ads on | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| KeywordID | Long | Keyword ID | |
| Title1 | String | Title1 | |
| Title2 | String | Title2 | |
| Title3 | String | Title3 | |
| Directory1 | String | Directory1 | |
| Directory2 | String | Directory2 | |
| Labels | String | Labels | |
| Labels_JSON_ | String | Labels(JSON) | |
| Searchabsolutetopimpressionrate | Double | Search absolute top impression rate | |
| Searchtopimpressionrate | Double | Search top impression rate | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost | |
| Title1_asset_ | String | Title 1 (asset) | |
| Title2_asset_ | String | Title 2 (asset) | |
| Title3_asset_ | String | Title 3 (asset) | |
| Title4_asset_ | String | Title 4 (asset) | |
| Title5_asset_ | String | Title 5 (asset) | |
| Title6_asset_ | String | Title 6 (asset) | |
| Title7_asset_ | String | Title 7 (asset) | |
| Title8_asset_ | String | Title 8 (asset) | |
| Title9_asset_ | String | Title 9 (asset) | |
| Title10_asset_ | String | Title 10 (asset) | |
| Title11_asset_ | String | Title 11 (asset) | |
| Title12_asset_ | String | Title 12 (asset) | |
| Title13_asset_ | String | Title 13 (asset) | |
| Title14_asset_ | String | Title 14 (asset) | |
| Title15_asset_ | String | Title 15 (asset) | |
| Description1_asset_ | String | Description 1 (asset) | |
| Description2_asset_ | String | Description 2 (asset) | |
| Description3_asset_ | String | Description 3 (asset) | |
| Description4_asset_ | String | Description 4 (asset) |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| DistributionSettings | String | Distribution Settings | |
| AdGroupBid | Long | Ad Group Bid | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| ImpressionShare | Double | Impression Share | |
| ExactMatchImpressionShare | Double | Exact Match Impression Share | |
| QualityLostImpressionShare | Double | Quality Lost Impression Share | |
| TrackingURL | String | Tracking URL | |
| CustomParameters | String | Custom Parameters | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| Showadson | String | Show ads on | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| Hourofday | Long | Hour of day | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Labels | String | Labels | |
| Labels_JSON_ | String | Labels(JSON) | |
| Searchabsolutetopimpressionrate | Double | Search absolute top impression rate | |
| Searchtopimpressionrate | Double | Search top impression rate | |
| Searchabsolutetopimpressionshare | Double | Search absolute top impression share | |
| Searchtopimpressionshare | Double | Search top impression share | |
| Searchlostabsolutetopimpressionshare_budget_ | Double | Search lost absolute top impression share (budget) | |
| Searchlostabsolutetopimpressionshare_rank_ | Double | Search lost absolute top impression share (rank) | |
| Searchlosttopimpressionshare_budget_ | Double | Search lost top impression share (budget) | |
| Searchlosttopimpressionshare_rank_ | Double | Search lost top impression share (rank) | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end date. |
To view the Asset Combination report, a simple SELECT statement generates and retrieves the report for the last 7 days.
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column 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 ReportSearchAdsAsset_combinations WHERE AccountId = '125466' SELECT * FROM ReportSearchAdsAsset_combinations WHERE AccountId = '125466' AND ReportJobId = '123456' SELECT * FROM ReportSearchAdsAsset_combinations WHERE AccountId = '125466' AND ReportDateRangeType = 'LAST_7_DAYS' SELECT * FROM ReportSearchAdsAsset_combinations 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignId | Long | Campaign ID | |
| AdGroupId | Long | AdGroup ID | |
| AdId | Long | Ad ID | |
| CampaignName | String | Campaign name | |
| AdGroupName | String | Ad group name | |
| AdName | String | Ad Name | |
| Impressions | Long | Impressions | |
| DeliveredTitle1 | String | Delivered title 1 | |
| DeliveredTitle2 | String | Delivered title 2 | |
| DeliveredTitle3 | String | Delivered title 3 | |
| ConcatenatedTitle | String | Concatenated title | |
| DeliveredDescription1 | String | Delivered description 1 | |
| DeliveredDescription2 | String | Delivered description 2 | |
| DeliveredImage1 | String | Delivered image 1 | |
| DeliveredImage2 | String | Delivered image 2 | |
| DeliveredImage3 | String | Delivered image 3 | |
| DeliveredQuickLink1 | String | Delivered quick link 1 | |
| DeliveredQuickLink2 | String | Delivered quick link 2 | |
| DeliveredQuickLink3 | String | Delivered quick link 3 | |
| DeliveredQuickLink4 | String | Delivered quick link 4 | |
| DeliveredQuickLink5 | String | Delivered quick link 5 | |
| DeliveredQuickLink6 | String | Delivered quick link 6 | |
| DeliveredQuickLink7 | String | Delivered quick link 7 | |
| DeliveredQuickLink8 | String | Delivered quick link 8 | |
| DeliveredCallout1 | String | Delivered callout 1 | |
| DeliveredCallout2 | String | Delivered callout 2 | |
| DeliveredCallout3 | String | Delivered callout 3 | |
| DeliveredCallout4 | String | Delivered callout 4 | |
| DeliveredCallout5 | String | Delivered callout 5 | |
| DeliveredCallout6 | String | Delivered callout 6 | |
| DeliveredCallout7 | String | Delivered callout 7 | |
| DeliveredCallout8 | String | Delivered callout 8 | |
| DeliveredCallout9 | String | Delivered callout 9 | |
| DeliveredCallout10 | String | Delivered callout 10 | |
| DeliveredCategorySnippet1 | String | Delivered category snippet 1 | |
| DeliveredCategorySnippet2 | String | Delivered category snippet 2 | |
| DeliveredCall | String | Delivered call |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| PortfoliobiddingID | Long | Portfolio bidding ID | |
| Portfoliobiddingname | String | Portfolio bidding name | |
| AutoBiddingType | String | Auto Bidding Type | |
| Campaigns | Long | Campaigns | |
| AdPosition_Targetpositioninsearchresults_ | String | Ad Position (Target position in search results) | |
| BiddingAdjustmentMethod_Targetpositioninsearchresults_ | String | Bidding Adjustment Method (Target position in search results) | |
| BiddingAdjustment_Targetpositioninsearchresults_ | Long | Bidding Adjustment (Target position in search results) | |
| LimitbyCampaignBudget_Targetpositioninsearchresults_ | String | Limit by Campaign Budget (Target position in search results) | |
| LowQualityKeyword_Targetpositioninsearchresults_ | String | Low Quality Keyword (Target position in search results) | |
| BidLimit_Targetpositioninsearchresults_ | Long | Bid Limit (Target position in search results) | |
| TargetCPA | Double | Target CPA | |
| BidLimit_TargetCPA_ | Long | Bid Limit (Target CPA) | |
| LowerBidLimit_TargetCPA_ | Long | Lower Bid Limit (Target CPA) | |
| TargetROAS | Double | Target ROAS | |
| BidLimit_TargetROAS_ | Long | Bid Limit (Target ROAS) | |
| LowerBidLimit_TargetROAS_ | Long | Lower Bid Limit (Target ROAS) | |
| BidLimit_MaximizeClicks_ | Long | Bid Limit (Maximize Clicks) | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| Hourofday | Long | Hour of day | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| CampaignName | String | Campaign Name | |
| DistributionSettings | String | Distribution Settings | |
| DistributionStatus | String | Distribution Status | |
| DailySpendingLimit | Long | Daily Spending Limit | |
| StartDate | String | Start Date | |
| EndDate | String | End Date | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| InvalidClicks | Long | Invalid Clicks | |
| InvalidClickRate | Double | Invalid Click Rate | |
| ImpressionShare | Double | Impression Share | |
| ExactMatchImpressionShare | Double | Exact Match Impression Share | |
| BudgetLostImpressionShare | Double | Budget Lost Impression Share | |
| QualityLostImpressionShare | Double | Quality Lost Impression Share | |
| TrackingURL | String | Tracking URL | |
| CustomParameters | String | Custom Parameters | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| Showadson | String | Show ads on | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| Hourofday | Long | Hour of day | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Campaigntype | String | Campaign type | |
| Labels | String | Labels | |
| Labels_JSON_ | String | Labels(JSON) | |
| PortfoliobiddingID | Long | Portfolio bidding ID | |
| Portfoliobiddingname | String | Portfolio bidding name | |
| Bidstrategy | String | Bid strategy | |
| EnhancedCPC | String | Enhanced CPC | |
| Searchabsolutetopimpressionrate | Double | Search absolute top impression rate | |
| Searchtopimpressionrate | Double | Search top impression rate | |
| Searchabsolutetopimpressionshare | Double | Search absolute top impression share | |
| Searchtopimpressionshare | Double | Search top impression share | |
| Searchlostabsolutetopimpressionshare_budget_ | Double | Search lost absolute top impression share (budget) | |
| Searchlostabsolutetopimpressionshare_rank_ | Double | Search lost absolute top impression share (rank) | |
| Searchlosttopimpressionshare_budget_ | Double | Search lost top impression share (budget) | |
| Searchlosttopimpressionshare_rank_ | Double | Search lost top impression share (rank) | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| AdID | Long | Ad ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| AdName | String | Ad Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| EditorialStatus | String | Editorial Status | |
| PhoneNumber | String | Phone Number | |
| FocusDevice | String | Focus Device | |
| FeedID | Long | Feed ID | |
| AdDisplayOptionID | Long | Ad Display Option ID | |
| QuickLinkText | String | QuickLink Text | |
| QuickLinkURL | String | QuickLink URL | |
| AdDisplayOptionType | String | Ad Display Option Type | |
| StartDate | String | Start Date | |
| EndDate | String | End Date | |
| TrackingURL | String | Tracking URL | |
| CustomParameters | String | Custom Parameters | |
| FinalURL | String | Final URL | |
| SmartphonefinalURL | String | Smartphone final URL | |
| Callout | String | Callout | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| AdTrackingID | Long | Ad Tracking ID | |
| AdDisplayOptionTrackingID | Long | Ad Display Option Tracking ID | |
| Showadson | String | Show ads on | |
| AdDisplayOptionDetail | String | Ad Display Option Detail | |
| AdDisplayOptionDetail_JSON_ | String | Ad Display Option Detail (JSON) | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| IsSelfAction | String | Is Self Action | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost | |
| QuickLinkDescription1 | String | QuickLink Description 1 | |
| QuickLinkDescription2 | String | QuickLink Description 2 | |
| DataAssignmentList | String | Data Assignment List | |
| TargetLocation | String | Target Location | |
| TargetKeyword | String | Target Keyword | |
| TargetKeywordMatchType | String | Target Keyword Match Type | |
| TargetCampaignID | Long | Target Campaign ID | |
| TargetAdGroupID | Long | Target Ad Group ID | |
| TargetLocationRestriction | String | Target Location Restriction |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| Showadson | String | Show ads on | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Country_Territory | String | Dimension: Country/Territory | |
| Prefecture | String | Dimension: Prefecture | |
| City | String | Dimension: City | |
| LocationType | String | Location Type | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost | |
| MetroArea | String | Metro Area | |
| Location | String | Location |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| CampaignName | String | Campaign Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| BidAdjustment_ | Double | Bid Adjustment(%) | |
| TargetLocationID | String | Target Location ID | |
| TargetLocationName | String | Target Location Name | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| Day | String | Dimension: Day | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| SearchQuery | String | Search Query | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| Titleautocreated | String | Title auto created | |
| URL | String | URL | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| KeywordID | Long | Keyword ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| CustomURL | String | Custom URL | |
| Keyword | String | Keyword | |
| DistributionSettings | String | Distribution Settings | |
| EditorialStatus | String | Editorial Status | |
| AdGroupBid | Long | Ad Group Bid | |
| Bid_JPY_ | Long | Bid (JPY) | |
| NegativeKeywords | String | Negative Keywords | |
| QualityIndex | Long | Quality Index | |
| FirstPageBidEstimate | Long | First Page Bid Estimate | |
| MatchType | String | Match Type | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| ImpressionShare | Double | Impression Share | |
| ExactMatchImpressionShare | Double | Exact Match Impression Share | |
| QualityLostImpressionShare | Double | Quality Lost Impression Share | |
| TopOfPageBidEstimate | Long | Top Of Page Bid Estimate | |
| TrackingURL | String | Tracking URL | |
| CustomParameters | String | Custom Parameters | |
| FinalURL | String | Final URL | |
| SmartphonefinalURL | String | Smartphone final URL | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| KeywordTrackingID | Long | Keyword Tracking ID | |
| Showadson | String | Show ads on | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Labels | String | Labels | |
| Labels_JSON_ | String | Labels(JSON) | |
| Searchabsolutetopimpressionrate | Double | Search absolute top impression rate | |
| Searchtopimpressionrate | Double | Search top impression rate | |
| Searchabsolutetopimpressionshare | Double | Search absolute top impression share | |
| Searchtopimpressionshare | Double | Search top impression share | |
| Searchlostabsolutetopimpressionshare_budget_ | Double | Search lost absolute top impression share (budget) | |
| Searchlostabsolutetopimpressionshare_rank_ | Double | Search lost absolute top impression share (rank) | |
| Searchlosttopimpressionshare_budget_ | Double | Search lost top impression share (budget) | |
| Searchlosttopimpressionshare_rank_ | Double | Search lost top impression share (rank) | |
| Keywordstatus | String | Keyword status | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost | |
| ExpectedCTR | String | Expected CTR | |
| Qualityindex_hist_ | Long | Quality index (hist.) | |
| ExpectedCTR_hist_ | String | Expected CTR (hist.) | |
| Adrelevance | String | Ad relevance | |
| Adrelevance_hist_ | String | Ad relevance (hist.) | |
| Landingpageexperience | String | Landing page experience | |
| Landingpageexperience_hist_ | String | Landing page experience (hist.) |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| LandingPageURL | String | Landing Page URL | |
| ExpandedLandingPageURL | String | Expanded Landing Page URL | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| Showadson | String | Show ads on | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| CampaignName | String | Campaign Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| BidAdjustment_ | Double | Bid Adjustment(%) | |
| TargetScheduleID | Long | Target Schedule ID | |
| TargetSchedule | String | Target Schedule | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| Day | String | Dimension: Day | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| KeywordID | Long | Keyword ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| SearchQuery | String | Search Query | |
| SearchQueryMatchType | String | SearchQueryMatch Type | |
| Keyword | String | Keyword | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| TrackingURL | String | Tracking URL | |
| FinalURL | String | Final URL | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| KeywordTrackingID | Long | Keyword Tracking ID | |
| Showadson | String | Show ads on | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Searchabsolutetopimpressionrate | Double | Search absolute top impression rate | |
| Searchtopimpressionrate | Double | Search top impression rate | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost | |
| Keyword_NegativeKeyword | String | Keyword / Negative Keyword |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | AccountId | |
| AccountName | String | Account Name | |
| CampaignID | Long | CampaignID | |
| AdGroupID | Long | Ad Group ID | |
| CampaignName | String | Campaign Name | |
| AdGroupName | String | Ad Group Name | |
| Cost | Long | Cost | |
| Impressions | Long | Impressions | |
| Clicks | Long | Clicks | |
| CTR | Double | CTR | |
| Avg_CPC | Double | Avg. CPC | |
| BidAdjustment_ | Double | Bid Adjustment(%) | |
| TargetpageID | Long | Target page ID | |
| Conversions | Double | Conversions | |
| Conv_Rate | Double | Conv. Rate | |
| Conv_Value | Double | Conv. Value | |
| CostPerConv_ | Double | Cost Per Conv. | |
| ValuePerConv_ | Double | Value Per Conv. | |
| AllConv_ | Double | All Conv. | |
| AllConv_Rate | Double | All Conv. Rate | |
| AllConv_Value | Double | All Conv. Value | |
| CostPerAllConv_ | Double | Cost Per All Conv. | |
| ValuePerAllConv_ | Double | Value Per All Conv. | |
| Conversionsacrossdevices | Double | Conversions across devices | |
| CampaignTrackingID | Long | Campaign Tracking ID | |
| AdGroupTrackingID | Long | Ad Group Tracking ID | |
| TargetpagetrackingID | Long | Target page tracking ID | |
| Showadson | String | Show ads on | |
| ClickType | String | Dimension: ClickType | |
| Device | String | Dimension: Device | |
| Day | String | Dimension: Day | |
| Dayofweek | String | Day of week | |
| Quarter | String | Dimension: Quarter | |
| Year | String | Dimension: Year | |
| Month | String | Dimension: Month | |
| MonthofYear | String | Month of Year | |
| Week | String | Dimension: Week | |
| ObjectiveofConversionTracking | String | Objective of Conversion Tracking | |
| ConversionName | String | Conversion Name | |
| Searchabsolutetopimpressionrate | Double | Search absolute top impression rate | |
| Searchtopimpressionrate | Double | Search top impression rate | |
| Conv_ValuePerCost | Double | Conv. Value Per Cost | |
| AllConv_ValuePerCost | Double | All Conv. Value Per Cost |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| ReportDateRangeType | String | ReportDefinitionService ReportDateRangeType displays a date range of the report | |
| DateRangeStartDate | String | The compilation start date | |
| DateRangeEndDate | String | The compilation end 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 | |
| IncludeSsaAccount | String | It represents whether the account to be retrieved includes an SSA account.
使用できる値は次のとおりです。ONLY_SSA, EXCLUDE_SSA, 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 | |
| ConversionSettingConversionGroupId | Int64 | Conversion Group ID. | |
| ConversionSettingGoalConfigLevel | String | Conversion goal config level.
使用できる値は次のとおりです。ACCOUNT, CAMPAIGN, UNKNOWN | |
| ConversionSettingCampaignConversionGoals | String | Campaign conversion goals. |
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. |
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, ASSET_COMBINATIONS | |
| 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, ASSET_COMBINATIONS | |
| 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, ASSET_COMBINATIONS | |
| 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, REFER_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 |
Read SSA account information for Search Ads.
The Sync App will use the Yahoo! Ads API to process WHERE clause conditions built with the following column and operator. The following columns are filterable on the server side and the rest of the filter is executed client-side within the Sync App.
SELECT * FROM SsaAccounts WHERE AccountId = '1002504155' SELECT * FROM SsaAccounts WHERE AccountStatus = 'INPROGRESS' SELECT * FROM SsaAccounts WHERE AccountType = 'INVOICE'
| Name | Type | References | Description |
| AccountId [KEY] | Int64 | Account ID. Unique identifier for the SSA account. | |
| AccountName | String | Account name. The name of the SSA account. | |
| AccountStatus | String | Account status. Current status of the SSA account.
使用できる値は次のとおりです。INPROGRESS, WAIT_DECIDE, SUSPENDED, SERVING, ENDED, UNKNOWN | |
| AccountType | String | Account type. Payment type of the SSA account.
使用できる値は次のとおりです。PREPAY, INVOICE, UNKNOWN | |
| AutoTaggingEnabled | String | Auto tagging enabled. Whether auto tagging is enabled for the account. | |
| ContactBizId | String | Contact business ID. Business ID associated with the account contact. | |
| DeliveryStatus | String | Delivery status. Current delivery status of the account. | |
| StartDate | Date | Start date. The start date of ad serving for the account. | |
| EndDate | Date | End date. The end date of ad serving for the account. |
ストアドプロシージャはファンクションライクなインターフェースで、Yahoo! Ads の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにYahoo! Ads から関連するレスポンスデータを返します。
| Name | Description |
| SearchAdsAddAdGroupAdLabels | To create SearchAds AdGroupAd Labels. |
| SearchAdsAddAdGroupCriterionLabels | To create SearchAds AdGroupCrietrion Labels. |
| SearchAdsAddAdGroupLabels | To create SearchAds AdGroup Labels. |
| SearchAdsAddCampaignLabels | To create SearchAds Campaign Labels. |
| SearchAdsRemoveAdGroupAdLabels | To remove SearchAds AdGroupAd Labels. |
| SearchAdsRemoveAdGroupCriterionLabels | To remove SearchAds AdGroupCriterion Labels. |
| SearchAdsRemoveAdGroupLabels | To remove SearchAds AdGroup Labels. |
| SearchAdsRemoveCampaignLabels | To remove SearchAds Campaign Labels. |
| SearchAdsSetAdGroupAdTrademarkStatus | When the trademark restriction is removed, a value indicates (removed) will be returned. |
Creates a schema file for the specified table or view.
データモデル内の既存のテーブルまたはビューからローカルスキーマファイル(.rsd)を作成します。
スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。
Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリがSync App のデータモデルに追加されます。
| Name | Type | Description |
| TableName | String | The name of the table or view. |
| FileName | String | The full file path and name of the schema to generate. Ex : 'C:\\Users\\User\\Desktop\\SmartSheet\\sheet.rsd' |
| Name | Type | Description |
| FileData | String | If the FileName and FileStream are not provided, this contains the content of the file. |
| Result | String | Returns Success or Failure. |
Gets an authentication token from Yahoo! Ads.
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。 |
| Scope | String | A comma-separated list of permissions to request from the user. Please check the Yahoo Ads API for a list of available permissions.
デフォルト値はyahooadsです。 |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Yahoo! Ads app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | The verifier returned from Yahoo! Ads after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Yahoo! Ads authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Yahoo! Ads. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Yahoo! Ads. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Description |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Yahoo! Ads app settings. |
| Scope | String | A comma-separated list of scopes to request from the user. Please check the Yahoo! Ads API documentation for a list of available permissions.
デフォルト値はyahooadsです。 |
| State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Yahoo! Ads authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with Yahoo! Ads.
| Name | Type | Description |
| OAuthRefreshToken | String | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Yahoo! Ads. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
To create SearchAds AdGroupAd Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsAddAdGroupAdLabels are AccountId, AdId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsAddAdGroupAdLabels AccountId = '1234339', AdId = '52654', AdGroupId = '24153', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| AdId | Int64 | Ad group Ad ID. Values can be Referred from SearchAdsAdGroupAds.AdId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from SearchAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from SearchAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To create SearchAds AdGroupCrietrion Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsAddAdGroupCriterionLabels are AccountId, AdGroupId, CriterionId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsAddAdGroupCriterionLabels AccountId = '1234339', AdGroupId = '24153', CriterionId = '52654', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from SearchAdsAdGroups.AdGroupId |
| CriterionId | Int64 | Criterion ID. Values can be Referred from AdGroupCriteria.CriterionId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from SearchAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To create SearchAds AdGroup Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsAddAdGroupAdLabels are AccountId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsAddAdGroupLabels AccountId = '1234339', AdGroupId = '24153', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from SearchAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from SearchAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To create SearchAds Campaign Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsAddCampaignLabels are AccountId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsAddCampaignLabels AccountId = '1234339', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Download the submitted image file.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsAssetServiceDownloadImage are AccountId and AssetId.
For example:
EXEC SearchAdsAssetServiceDownloadImage accountId=1234566, assetid=5363471; EXEC SearchAdsAssetServiceDownloadImage accountId=1234566, assetid=5363471, DownloadLocation='D:/image.jpg';
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| AssetId | Int64 | Asset ID. |
| DownloadLocation | String | Download location. For example: C:\Image.png |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Insert the image type asset data into the asset.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsAssetServiceUploadImage are AccountId, ImageName, and (FileLocation or content).
For example:
EXEC SearchAdsAssetServiceUploadImage accountId=1234339, ImageName='img.jpeg', filelocation='C:/img.jpg';
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| ImageName | String | Image name. |
| ImageAspectRatio | String | The type of aspect ratio. |
| ImageFileSize | Int64 | The file size of image. |
| ImageHeight | Int64 | The height of image. |
| ImageWidth | Int64 | The width of image. |
| ImageFileType | String | The file type of image.
使用できる値は次のとおりです。PNG, JPEG, UNKNOWN |
| FileLocation | String | File to upload. |
| Content | String | The content as Base64 encoded string to be uploading when FileLocation is not specified. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| AssetId | String | Asset Id. |
Download the export result.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsDownloadCampaignExport are AccountId, JobId and DownloadLocation.
For example:
EXECUTE SearchAdsDownloadCampaignExport AccountId = '1234339', JobId = '303244007', DownloadLocation = 'C:/DownloadCampaignExport.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| JobId | Int64 | Job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download offline conversion files as well as error files.
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| UploadId | Int64 | Upload ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download offline conversion error files.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsDownloadOfflineConversionErrorFile are AccountId, UploadId and DownloadLocation.
For example:
EXECUTE SearchAdsDownloadOfflineConversionErrorFile AccountId = '8976', UploadId = '78945', DownloadLocation = 'C:/DownloadOfflineConversionErrorFile.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| UploadId | Int64 | Upload ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download the SearchAds report.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsDownloadReport are AccountId, ReportJobId and DownloadLocation
For example:
EXECUTE SearchAdsDownloadReport AccountId = '1265', ReportJobId = '8974', DownloadLocation = 'C:/SearchAdsDownloadReport.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| ReportJobId | Int64 | Report Job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Download the data of user operation history.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsDownloadUserOperationHistory are AccountId, ReportJobId and DownloadLocation
For example:
EXECUTE SearchAdsDownloadUserOperationHistory AccountId = '3021', AuditLogJobId = '5698', DownloadLocation = 'C:/DownloadFeedDataErrorFile.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| JobId | Int64 | The operation history job ID. |
| DownloadLocation | String | Download location. For example: C:\Report.csv |
| Encoding | String | The FileData input encoding type.
使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。 |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |
Registers job to bulk download registered page feed asset.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsPageFeedAssetServiceAddDownloadJob are AccountId and PageFeedAssetSetId.
For example:
EXECUTE SearchAdsPageFeedAssetServiceAddDownloadJob AccountId = '1234339', PageFeedAssetSetId='1841'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| BulkEncoding | String | It displays encoding(character code) of Page feed asset file. |
| BulkLang | String | It displays language setting of Page feed asset file. |
| BulkOutput | String | It specifies format of Page feed asset file. |
| DownloadJobStatus | String | It displays status of page feed asset download jobs. |
| EndDate | String | End date of job. |
| JobId | Int64 | Job Id. |
| PageFeedAssetSetId | Int64 | PageFeedAssetSet ID. |
| Progress | Int32 | Progress of page feed asset job. |
| StartDate | String | Start date of job. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To remove SearchAds AdGroupAd Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsRemoveAdGroupAdLabels are AccountId, AdId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsRemoveAdGroupAdLabels AccountId = '1234339', AdId = '25461', AdGroupId = '23654', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| AdId | Int64 | Ad group Ad ID. Values can be Referred from SearchAdsAdGroupAds.AdId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from SearchAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from SearchAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To remove SearchAds AdGroupCriterion Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsRemoveAdGroupCriterionLabels are AccountId, AdGroupId, CriterionId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsRemoveAdGroupCriterionLabels AccountId = '1234339', AdGroupId = '23654', CriterionId = '45261', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from SearchAdsAdGroups.AdGroupId |
| CriterionId | Int64 | Criterion ID. Values can be Referred from AdGroupCriteria.CriterionId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from SearchAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To remove SearchAds AdGroup Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsRemoveAdGroupLabels are AccountId, AdGroupId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsRemoveAdGroupLabels AccountId = '1234339', AdGroupId = '23654', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| AdGroupId | Int64 | Ad Group ID. Values can be Referred from SearchAdsAdGroups.AdGroupId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. Values can be Referred from SearchAdsLabels.LabelId |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
To remove SearchAds Campaign Labels.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsRemoveCampaignLabels are AccountId, CampaignId and LabelId.
For example:
EXECUTE SearchAdsRemoveCampaignLabels AccountId = '1234339', CampaignId = '321452', LabelId = '12354'
| Name | Type | Description |
| AccountId | Int64 | Account ID. Values can be Referred from SearchAdsAccounts.AccountId |
| CampaignId | Int64 | Campaign ID. Values can be Referred from SearchAdsCampaigns.CampaignId |
| LabelId | Int64 | Label ID. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
When the trademark restriction is removed, a value indicates (removed) will be returned.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsSetAdGroupAdTrademarkStatus are AccountId, AdGroupId, AdId and CampaignId.
For example:
EXECUTE SearchAdsSetAdGroupAdTrademarkStatus AccountId = '8976', AdGroupId = '58971', AdId = '7895', CampaignId = '1236'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| AdGroupId | Int64 | Ad group ID. |
| AdId | Int64 | Ad ID. |
| CampaignId | Int64 | Campaign ID. |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
Execute upload offline conversion data.
Yahoo! Ads allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required columns in SearchAdsUploadOfflineConversion are AccountId, UploadType and UploadFileName.
For example:
Execute SearchAdsUploadOfflineConversion AccountId = '123436', UploadType = 'NEW', FileLocation = 'C:\UploadOfflineConversion.txt'
| Name | Type | Description |
| AccountId | Int64 | Account ID. |
| UploadType | String | Uploaded type.
使用できる値は次のとおりです。NEW, ADJUSTMENT, UNKNOWN |
| UploadFileName | String | Uploaded file name. |
| FileLocation | String | Name of the file to be uploaded only when content is given. For example: test.csv |
| Name | Type | Description |
| Status | String | Execution status of the stored procedure |
| プロパティ | 説明 |
| DisplayAdsAccountId | DisplayAds アカウントに関連付けられた一意の識別子。 |
| SearchAdsAccountId | SearchAds アカウントに関連付けられた一意の識別子。 |
| Language | レポート定義サービスReportLanguage は、定義されたカラム名の言語を提供します。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| 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 を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能な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(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がYahoo! Ads への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がYahoo! Ads への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がYahoo! Ads にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
Note: Sync App は複数のスキーマをサポートするため、Yahoo! Ads のカスタムスキーマファイルは以下のような構造にになります。
Location は常に親フォルダに設定されるべきで、個々のスキーマのフォルダに設定すべきではありません。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\YahooAds Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM [YahooAds].[SearchAds].SearchAdsAdGroups WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.