CData Python Connector for Yahoo! Ads

Build 22.0.8479

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'.
  • ApprovalStatus supports the '=,IN'.
  • CampaignId supports the '=,IN'.
  • MediaId supports the '=,IN'.
  • UserStatus supports the '=,IN'.
  • CampaignGoalFilterType supports the '='.
  • ContainsLabelIdFlg supports the '='.
  • LabelId supports the '=,IN'.
  • StartDate supports the '='.
  • EndDate supports the '='.
For example:
SELECT * FROM DisplayAdsAdGroupAds WHERE AccountId = '125466'

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

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

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

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

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

INSERT

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

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

UPDATE

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

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

DELETE

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

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

Columns

Name Type ReadOnly References Description
AdId [KEY] Int64 True

Ad ID

AccountId Int64 True

DisplayAdsAccounts.AccountId

Account ID

AdGroupId Int64 True

DisplayAdsAdGroups.AdGroupId

Ad group ID

AdType String False

Types of ad.

使用できる値は次のとおりです。TEXT_SHORT_AD2, RESPONSIVE_IMAGE_AD, STATIC_FRAME_AD, BANNER_VIDEO_AD, RESPONSIVE_VIDEO_AD, DYNAMIC_AD, TEXT_LONG_AD1, TEXT_LONG_AD2, TEXT_SHORT_AD1, BANNER_IMAGE_AD, POS_AD, UNKNOWN

BannerImageAdDisplayUrl String False

Display URL.

BannerImageAdUrl String False

Destination URL.

BannerImageAdCustomParametersIsRemove String False

Delete flag.

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

BannerImageAdCustomParameters String False

Displays the element of custom parameters.

BannerImageAdDisplayUrlLevel String False

Display URL.

BannerImageAdFinalUrl String False

Final URL.

BannerImageAdSmartphoneFinalUrl String False

Final URL (smartphone).

BannerImageAdisRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

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

BannerImageAdisRemoveTrackingUrl String False

Flag for removing an information item.

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

BannerImageAdtrackingUrl String False

Destination URL.

BannerVideoAdDisplayUrl String False

Display URL.If adType is BANNER_IMAGE_AD, this field is required in ADD operation.

BannerVideoAdAddisplayUrlLevel String False

Display URL.

BannerVideoAdAdFinalUrl String False

Final URL.

BannerVideoAdAdSmartphoneFinalUrl String False

Final URL (smartphone).

BannerVideoAdAdisRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

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

BannerVideoAdAdisRemoveTrackingUrl String False

Flag for removing an information item.

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

BannerVideoAdIsRemoveVideo10SecBeaconUrls String False

Flag for removing an information item.

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

BannerVideoAdIsRemoveVideo25PercentBeaconUrls String False

Flag for removing an information item.

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

BannerVideoAdIsRemoveVideo3SecBeaconUrls String False

Flag for removing an information item.

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

BannerVideoAdIsRemoveVideo50PercentBeaconUrls String False

Flag for removing an information item

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

BannerVideoAdIsRemoveVideo75PercentBeaconUrls String False

Flag for removing an information item.

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

BannerVideoAdCustomParametersIsRemove String False

Delete flag.

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

BannerVideoAdCustomParameters String False

Displays the element of custom parameters.

BannerVideoAdIsRemoveVideoCompleteBeaconUrls String False

Flag for removing an information item.

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

BannerVideoAdIsRemoveVideoStartBeaconUrls String False

Flag for removing an information item.

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

BannerVideoAdThumbnailMediaId Int64 False

Thumbnail ID.If adType is BANNER_VIDEO_AD, this field is required in ADD operation.

BannerVideoAdUrl String False

Destination URL

BannerVideoAdVideo10SecBeaconUrls String False

Viewing beacon URL (10 seconds).

BannerVideoAdVideo25PercentBeaconUrls String False

Playback viewing beacon URL (25%).

BannerVideoAdVideo3SecBeaconUrls String False

Beacon URL (3 seconds).

BannerVideoAdVideo50PercentBeaconUrls String False

Playback viewing beacon URL (50%)

BannerVideoAdVideo75PercentBeaconUrls String False

Playback viewing beacon URL (75%)

BannerVideoAdVideoCompleteBeaconUrls String False

Beacon URL (complete)

BannerVideoAdVideoStartBeaconUrls String False

beacon URL (start)

DynamicAdBrandColor String False

Brand color. Format= RGB or HEX

DynamicAdButtonText String False

Displays the button text.

使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN

デフォルト値はMORE_DETAILです。

DynamicAdDisplayUrl String False

Display URL.If adType is BANNER_IMAGE_AD, this field is required in ADD operation.

DynamicAdAddisplayUrlLevel String False

Display URL.

DynamicAdAdFinalUrl String False

Final URL.

DynamicAdAdSmartphoneFinalUrl String False

Final URL (smartphone).

DynamicAdAdisRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

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

DynamicAdAdisRemoveTrackingUrl String False

Flag for removing an information item.

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

DynamicAdCampaignBannerMediaId Int64 False

Campaign banner media ID.

DynamicAdCampaignBannerMediaId2 Int64 False

Campaign banner media ID 2.

DynamicAdCampaignBannerMediaId3 Int64 False

Campaign banner media ID 3

DynamicAdCampaignBannerMediaId4 Int64 False

Campaign banner media ID 4.

DynamicAdCampaignBannerUrl String False

Campaign banner URL

DynamicAdCustomParametersIsRemove String False

Delete flag.

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

DynamicAdCustomParameters String False

Displays the element of custom parameters.

DynamicAdIsRemoveBrandColor String False

Flag for removing an information item

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

DynamicAdIsRemoveCampaignBannerMediaId String False

Flag for removing an information item

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

DynamicAdIsRemoveCampaignBannerMediaId2 String False

Flag for removing an information item

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

DynamicAdIsRemoveCampaignBannerMediaId3 String False

Flag for removing an information item

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

DynamicAdIsRemoveCampaignBannerMediaId4 String False

Flag for removing an information item

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

DynamicAdIsRemoveCampaignBannerUrl String False

Flag for removing an information item

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

DynamicAdIsRemovePrefix String False

Flag for removing an information item

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

DynamicAdIsRemoveSuffix String False

Flag for removing an information item

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

DynamicAdLogoMediaId Int64 False

Media ID of logo image

DynamicAdLogoMediaId2 Int64 False

Media ID of logo image 2.

DynamicAdLogoMediaId3 Int64 False

Media ID of logo image 3.

DynamicAdPrefix String False

Prefix

DynamicAdPrincipal String False

Advertiser Indication

DynamicAdSuffix String False

Suffix

DynamicAdUrl String False

Destination URL

MobileAdDescription String False

Description text (line 1).

MobileAdDescription2 String False

Description text (line 2).

MobileAdDisplayUrl String False

Display URL.

MobileAdHeadline String False

Title

MobileAdMobileCarriers String False

Carrier types. The allowed values are DOCOMO,KDDI,SOFTBANK,NONE,UNKNOWN

MobileAdUrl String False

Destination URL

PosAdDescription String False

Description

PosAdUrl String False

Destination URL.

ResponsiveImageAdButtonText String False

Displays the button text.

使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN

デフォルト値はMORE_DETAILです。

ResponsiveImageAdDescription String False

Description.

ResponsiveImageAdDisplayUrl String False

Display URL

ResponsiveImageAddisplayUrlLevel String False

Display URL.

ResponsiveImageAdFinalUrl String False

Final URL.

ResponsiveImageAdSmartphoneFinalUrl String False

Final URL (smartphone).

ResponsiveImageAdisRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

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

ResponsiveImageAdisRemoveTrackingUrl String False

Flag for removing an information item.

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

ResponsiveImageAdCustomParametersIsRemove String False

Delete flag.

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

ResponsiveImageAdCustomParameters String False

Displays the element of custom parameters.

ResponsiveImageAdHeadline String False

Title

ResponsiveImageAdIsRemoveLogoMediaId String False

Flag for removing an information item

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

ResponsiveImageAdLogoMediaId Int64 False

Media ID of logo image.

ResponsiveImageAdPrincipal String False

Advertiser Indication of the ad

ResponsiveImageAdUrl String False

Destination URL.

ResponsiveVideoAdButtonText String False

Types of ad.

使用できる値は次のとおりです。TEXT_SHORT_AD2, RESPONSIVE_IMAGE_AD, STATIC_FRAME_AD, BANNER_VIDEO_AD, RESPONSIVE_VIDEO_AD, DYNAMIC_AD, TEXT_LONG_AD1, TEXT_LONG_AD2, TEXT_SHORT_AD1, BANNER_IMAGE_AD, POS_AD, UNKNOWN

ResponsiveVideoAdDescription String False

Ad description.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.

ResponsiveVideoAdCustomParametersIsRemove String False

Delete flag.

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

ResponsiveVideoAdCustomParameters String False

Displays the element of custom parameters.

ResponsiveVideoAdDisplayUrl String False

Display URL.

ResponsiveVideoAdHeadline String False

Ad title.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.

ResponsiveVideoAdIsRemoveLogoMediaId String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideo10SecBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideo25PercentBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideo3SecBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideo50PercentBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideo75PercentBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideoCompleteBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdIsRemoveVideoStartBeaconUrls String False

Flag for removing an information item

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

ResponsiveVideoAdLogoMediaId Int64 False

Logo image ID.

ResponsiveVideoAdPrincipal String False

Advertiser Indication of the ad.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.

ResponsiveVideoAdThumbnailMediaId Int64 False

Thumbnail ID.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.

ResponsiveVideoAdUrl String False

Destination URL.If adType is RESPONSIVE_VIDEO_AD, this field is required in ADD operation.

ResponsiveVideoAdVideo10SecBeaconUrls String False

Beacon URL (10 seconds)

ResponsiveVideoAdVideo25PercentBeaconUrls String False

Playback viewing beacon URL (25%).

ResponsiveVideoAdVideo3SecBeaconUrls String False

Beacon URL (3 seconds).

ResponsiveVideoAdVideo50PercentBeaconUrls String False

Playback viewing beacon URL (50%)

ResponsiveVideoAdVideo75PercentBeaconUrls String False

Playback viewing beacon URL (75%)

ResponsiveVideoAdVideoCompleteBeaconUrls String False

Beacon URL (complete)

ResponsiveVideoAdVideoStartBeaconUrls String False

Beacon URL (start)

StaticFrameAdButtonText String False

Displays the button text.

使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN

デフォルト値はMORE_DETAILです。

StaticFrameAdColorSetId Int64 False

Color set ID.

StaticFrameAdDescription String False

Description.

StaticFrameAdDisplayUrl String False

Display URL.

StaticFrameAdHeadline String False

Title.

StaticFrameAdIsRemoveLogoMediaId String False

Flag for removing an information item

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

StaticFrameAdLayout String False

Ad Layout.

StaticFrameAdLogoMediaId Int64 False

Media ID of logo image

StaticFrameAdPrincipal String False

Advertiser Indication

StaticFrameAdSize String False

Ad Size.

StaticFrameAdUrl String False

Destination URL

TextAdDescription String False

Description text (line 1).If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.

TextAdDescription2 String False

Description text (line 2).If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.

TextAddisplayUrlLevel String False

Display URL.

TextAdFinalUrl String False

Final URL.

TextAdSmartphoneFinalUrl String False

Final URL (smartphone).

TextAdisRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

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

TextAdisRemoveTrackingUrl String False

Flag for removing an information item.

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

TextAdCustomParametersIsRemove String False

Delete flag.

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

TextAdCustomParameters String False

Displays the element of custom parameters.

TextAdDisplayUrl String False

Display URL.However, not allowed for ADD and SET when a campaign goal is app promotion. Based on DeviceOsType specified on the campaign, any of the following URLs will be automatically For iOS : itunes.apple.com,For Android : play.google.com

TextAdHeadline String False

Title.If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.

TextAdUrl String False

Destination URL.If adType is TEXT_LONG_AD1 or TEXT_SHORT_AD2, this field is required in ADD operation.

CarouselAdCustomParametersIsRemove String False

Delete flag.

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

CarouselCustomParameters String False

Displays the element of custom parameters.

CarouselAdButtonText String False

Displays the button text.

使用できる値は次のとおりです。INSTALL, MORE_DETAIL, CONFIRM_PROPERTY, DOWNLOAD, DOWNLOAD, PURCHASE_NOW, REQUEST_INFO, RESERVE_NOW, REGISTER_NOW, EXPERIENCE, RESERVE_HERE, APPLY_NOW, FOR_MORE_INFO, PURCHASE, CONTACT_US, CONFIRM_NOW, APPLY_HERE, UNKNOWN

デフォルト値はMORE_DETAILです。

CarouselAdCarousels String False

Describes the detailed information of carousel ad.In SET operation, all Carousel included in the current Carousels will be replaced with the specified Carousels.Cannot specify a specific Carousel alone.

CarouselAdDisplayUrl String False

Display URLHowever, not allowed for ADD and SET when a campaign goal is app promotion. Based on DeviceOsType specified on the campaign, any of the following URLs will be automatically set.For iOS : itunes.apple.com,For Android : play.google.com

CarouselAdLogoMediaId Int64 False

Logo image ID.

CarouselAdPrincipal String False

Advertiser Indication of the ad.However,If adType is CAROUSEL_AD, this field is required in ADD operation. if campaignGoal is APP_PROMOTION, it will automatically be set to the same value as appName of campaign, and it cannot be changed to any other value.

CarouselAdUrl String False

Destination URL.For information about the destination URL that can be set with campaigns for app promotion, refer to this page.This field is required in ADD operation, and will be optional in SET operation.If adType is CAROUSEL_AD, this field is required in ADD operation

CarouselAddisplayUrlLevel String False

Display URL Level.

CarouselAdFinalUrl String False

Final URL.

CarouselAdSmartphoneFinalUrl String False

Final URL (smartphone).

CarouselAdisRemoveSmartphoneFinalUrl String False

Flag for removing an information item.

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

CarouselAdisRemoveTrackingUrl String False

Flag for removing an information item.

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

GroupName String False

Ad group name

Name String False

Ad name.

Style String False

Displays the ad style type.

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

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 Date True

Date of Ad made

DisapprovalReasonCodes String False

Reject reason on editorial review

ImpressionBeaconUrls String False

Impression beacon URL

IsRemoveBeaconUrls String False

Flag for removing an information item

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

IsRemoveThirdPartyTrackingScriptUrl String False

Flag for removing an information item

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

Labels String False

Describes label information to be associated

MediaId Int64 False

Media.MediaId

Media ID

ThirdPartyTrackingScriptUrl String False

Third party tracking script URL

ThirdPartyTrackingVendor String False

Third party tracking vendor (Read only).

UserStatus String False

Delivery status that can be set by an user

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

Pseudo-Columns

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

Name Type Description
CampaignGoalFilterType String

Setting for filtering campaigns (with campaignGoal) or (with no campaignGoal).

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

デフォルト値はALLです。

ContainsLabelIdFlg String

Flag of contains label ID.

LabelId String

Label ID.

StartDate Date

start date of the search target period.

EndDate Date

This is the end date of the search target period.

ReferenceNumber String

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

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479