Cmdlets for Yahoo! Ads

Build 24.0.9062

DisplayAdsAdGroupAds

Create, Read, Update or Delete ad information

Table Specific Information

Select

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

  • AccountId supports the '='.
  • AdGroupId supports the '=,IN'.
  • AdId supports the '=,IN'.
  • AdType supports the '=,IN'.
  • MainMediaFormat supports the '=,IN'.
  • ApprovalStatus supports the '=,IN'.
  • CampaignId supports the '=,IN'.
  • MediaId supports the '=,IN'.
  • UserStatus supports the '=,IN'.
  • CampaignGoalFilterType supports the '='.
  • ContainsLabel supports the '='.
  • LabelId supports the '=,IN'.
  • StartDate supports the '='.
  • EndDate supports the '='.
For example: 
SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '125466'

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

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

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

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

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

INSERT

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

INSERT INTO DisplayAdsAdGroupAds (AccountId, AdGroupId, AdType, TextAdDescription, TextAdDescription2, TextAdDisplayUrl, TextAdHeadline, Name, ApprovalStatus, CampaignId, UserStatus) values ('1002504155','437279778','TEXT_LONG_AD1','Test1','Test2','itunes.apple.com','TestHeadlines','TestName','REVIEW','30820477','ACTIVE')

UPDATE

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

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

DELETE

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

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

Columns

Name Type ReadOnly References Description
AdId [KEY] Int64 False

Ad ID.

AccountId Int64 False

DisplayAdsAccounts.AccountId

Account ID.

AdGroupId Int64 False

DisplayAdsAdGroups.AdGroupId

Ad group ID.

AdType String False

Types of ad.

使用できる値は次のとおりです。BANNER_AD, CAROUSEL_AD, DYNAMIC_DISPLAY_AD, RESPONSIVE_AD, TEXT_AD, UNKNOWN

BannerAdIsRemoveVideo10SecBeaconUrls String False

Flag for removing an information item.

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

BannerAdIsRemoveVideo25PercentBeaconUrls String False

Flag for removing an information item.

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

BannerAdIsRemoveVideo3SecBeaconUrls String False

Flag for removing an information item.

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

BannerAdIsRemoveVideo50PercentBeaconUrls String False

Flag for removing an information item.

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

BannerAdIsRemoveVideo75PercentBeaconUrls String False

Flag for removing an information item.

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

BannerAdIsRemoveVideoCompleteBeaconUrls String False

Flag for removing an information item.

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

BannerAdIsRemoveVideoStartBeaconUrls String False

Flag for removing an information item.

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

BannerAdThumbnailMediaId Int64 False

Thumbnail ID.

BannerAdVideo10SecBeaconUrls String False

Viewing beacon URL (10 seconds).

BannerAdVideo25PercentBeaconUrls String False

Playback viewing beacon URL (25%).

BannerAdVideo3SecBeaconUrls String False

Viewing beacon URL (3 seconds).

BannerAdVideo50PercentBeaconUrls String False

Playback viewing beacon URL (50%).

BannerAdVideo75PercentBeaconUrls String False

Playback viewing beacon URL (75%).

BannerAdVideoCompleteBeaconUrls String False

Viewing beacon URL (complete).

BannerAdVideoStartBeaconUrls String False

Viewing beacon URL (start).

CarouselAdButtonText String False

Displays the button text.

CarouselAdCarousels String False

Describes the detailed information of carousel ad.

CarouselAdLogoMediaId Int64 False

Logo image ID.

CarouselAdPrincipal String False

Advertiser Indication of the ad.

CustomParametersIsRemove String False

Flag for removing an information item.

CustomParametersParameters String False

Displays the element of custom parameters.

DisplayUrl String False

Display URL.

DisplayUrlLevel String False

Describes a level of URL to display.

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

DynamicDisplayAdBrandColor String False

Brand color.

DynamicDisplayAdButtonText String False

Displays the button text.

DynamicDisplayAdCampaignBannerMediaId Int64 False

Campaign banner media ID.

DynamicDisplayAdCampaignBannerMediaId2 Int64 False

Campaign banner media ID2.

DynamicDisplayAdCampaignBannerMediaId3 Int64 False

Campaign banner media ID3.

DynamicDisplayAdCampaignBannerMediaId4 Int64 False

Campaign banner media ID4.

DynamicDisplayAdCampaignBannerUrl String False

Campaign banner URL.

DynamicDisplayAdIsRemoveBrandColor String False

Flag for removing an information item.

DynamicDisplayAdIsRemoveCampaignBannerMediaId String False

Flag for removing an information item.

DynamicDisplayAdIsRemoveCampaignBannerMediaId2 String False

Flag for removing an information item.

DynamicDisplayAdIsRemoveCampaignBannerMediaId3 String False

Flag for removing an information item.

DynamicDisplayAdIsRemoveCampaignBannerMediaId4 String False

Flag for removing an information item.

DynamicDisplayAdIsRemoveCampaignBannerUrl String False

Flag for removing an information item.

DynamicDisplayAdIsRemovePrefix String False

Flag for removing an information item.

DynamicDisplayAdIsRemoveSuffix String False

Flag for removing an information item.

DynamicDisplayAdLogoMediaId Int64 False

Media ID of logo image.

DynamicDisplayAdLogoMediaId2 Int64 False

Media ID of logo image 2.

DynamicDisplayAdLogoMediaId3 Int64 False

Media ID of logo image 3.

DynamicDisplayAdPrefix String False

Prefix.

DynamicDisplayAdPrincipal String False

Advertiser Indication.

DynamicDisplayAdSuffix String False

Suffix.

FinalUrl String False

Final URL.

IsRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

IsRemoveTrackingUrl String False

Flag for removing an information item.

MainMediaFormat String False

It describes the main media format.

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

ResponsiveAdAssetDescriptionAssets String False

Represents a description asset to specify in responsive display ads.

ResponsiveAdAssetHeadlineAssets String False

Represents a headline asset to specify in responsive display ads.

ResponsiveAdAssetMediaAssets String False

Represents a media asset to specify in responsive display ads.

ResponsiveAdButtonText String False

Displays the button text.

ResponsiveAdDescription String False

Ad description.

ResponsiveAdHeadline String False

Ad title.

ResponsiveAdIsRemoveLogoMediaId String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideo10SecBeaconUrls String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideo25PercentBeaconUrls String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideo3SecBeaconUrls String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideo50PercentBeaconUrls String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideo75PercentBeaconUrls String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideoCompleteBeaconUrls String False

Flag for removing an information item.

ResponsiveAdIsRemoveVideoStartBeaconUrls String False

Flag for removing an information item.

ResponsiveAdLogoMediaId Int64 False

Logo image ID.

ResponsiveAdPrincipal String False

Advertiser Indication of the ad.

ResponsiveAdThumbnailMediaId Int64 False

Thumbnail ID.

ResponsiveAdVideo10SecBeaconUrls String False

Viewing beacon URL (10 seconds).

ResponsiveAdVideo25PercentBeaconUrls String False

Playback viewing beacon URL (25%).

ResponsiveAdVideo3SecBeaconUrls String False

Viewing beacon URL (3 seconds).

ResponsiveAdVideo50PercentBeaconUrls String False

Playback viewing beacon URL (50%).

ResponsiveAdVideo75PercentBeaconUrls String False

Playback viewing beacon URL (75%).

ResponsiveAdVideoCompleteBeaconUrls String False

Viewing beacon URL (complete).

ResponsiveAdVideoStartBeaconUrls String False

Viewing beacon URL (start).

SmartphoneFinalUrl String False

Final URL (smartphone).

TextAdDescription String False

Description text (line 1).

TextAdDescription2 String False

Description text (line 2).

TextAdHeadline String False

Title.

TrackingUrl String False

Tracking URL.

AdGroupName String False

Ad group name.

AdName String False

Ad name.

ApprovalStatus String False

Editorial status.

使用できる値は次のとおりです。APPROVED, APPROVED_WITH_REVIEW, REVIEW, PRE_DISAPPROVED, POST_DISAPPROVED, UNKNOWN

CampaignId Int64 False

DisplayAdsCampaigns.CampaignId

Campaign ID.

CampaignName String False

Campaign name.

CreatedDate String False

Date of Ad made.

DisapprovalReasonCodes String False

Reject reason on editorial review.

DisapprovalReasonDescription String False

Reject reason details on editorial review.

ImpressionBeaconUrls String False

Impression beacon URL.

IsRemoveImpressionBeaconUrls String False

Flag for removing an information item.

IsRemoveThirdPartyTrackingScriptUrl String False

Flag for removing an information item.

IsRemoveViewableImpressionBeaconUrls String False

Flag for removing an information item.

Labels String False

Describes label information to be associated.

MediaId Int64 False

Media.MediaId

Media ID.

ThirdPartyTrackingScriptUrl String False

Third party tracking script URL.

ThirdPartyTrackingVendor String True

Third party tracking vendor.

UserStatus String False

Delivery status that can be set by an user

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

ViewableImpressionBeaconUrls String False

Viewable impression beacon URL.

Pseudo-Columns

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.

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