ADO.NET Provider for Yahoo! Ads

Build 23.0.8839

SearchAdsAdGroupAds

Create, Read, Update and Delete Ad group 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,='.
  • ApprovalStatus supports the 'IN,='.
  • CampaignId supports the 'IN,='.
  • ContainsLabel supports the '='.
  • Userstatus supports the 'IN,='.
  • LabelIds supports the 'IN,='.
  • StartDate supports the '='.
  • EndDate supports the '='.

For example: 

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdGroupId = '456971'	

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdId = '87952'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND AdType='EXTENDED_TEXT_AD'	

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND CampaignId = '0147'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND ContainsLabel = '89456'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND Userstatus = 'PAUSED'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND StartDate = '2021-02-15'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '25687' AND EndDate = '2021-06-03'

INSERT

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

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

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'

Columns

Name Type ReadOnly References Description
AdId [KEY] Int64 True

Ad ID.

AccountId Int64 True

SearchAdsAccounts.AccountId

Account ID.

AdGroupId Int64 True

SearchAdsAdGroups.AdGroupId

Ad group ID.

AdGroupName String False

Ad group name.

AdGroupTrackId Int64 False

Ad group ID for tracking.

AdName String False

Ad name.

AdTrackId Int64 False

Ad ID for tracking.

AdType String False

Device type and number of title and description character.

使用できる値は次のとおりです。EXTENDED_TEXT_AD, DYNAMIC_SEARCH_LINKED_AD, TEXT_AD2, APP_AD, RESPONSIVE_SEARCH_AD, UNKNOWN

SmartphoneFinalUrl String False

Landing Page URL (Smartphone).

FinalUrl String False

Landing Page URL.

AppAdAppId String False

App ID. If adType is APP_AD, this field is required.

AppAdAppStore String False

App Store. If adType is APP_AD, this field is required.

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

AppAdDescription2 String False

Description2 (line2) of the ad.If adType is APP_AD, this field is required.

CustomParametersIsRemove String False

Delete flag.

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

CustomParametersParameters String False

displays the element of custom parameters.

DevicePreference String False

A device delivering an advertisement with precedence. If adType is EXTENDED_TEXT_AD, this field will be ignored.

DisplayUrl String False

Display URL.

ExtendedTextAdDescription2 String False

Description on the second line. If adType is EXTENDED_TEXT_AD, this field is required.

ExtendedTextAdHeadline2 String False

Title on the second line. If adType is EXTENDED_TEXT_AD, this field is required.

ExtendedTextAdHeadline3 String False

Title on the second line. If adType is EXTENDED_TEXT_AD, this field is required.

ExtendedTextAdPath1 String False

The path information which complements display URL generated automatically. To specify path2, path1 is required. f adType is EXTENDED_TEXT_AD, this field is required.

ExtendedTextAdPath2 String False

The path information which complements display URL generated automatically. If path1 is not specified, path2 will be ignored. f adType is EXTENDED_TEXT_AD, this field is required.

ResponsiveSearchAdDescriptions String False

Displays the text asset for the description that specify in responsive ad. If adType is RESPONSIVE_SEARCH_AD, this field is required.

ResponsiveSearchAdHeadlines String False

Displays the text asset for the headline that specify in responsive ad. If adType is RESPONSIVE_SEARCH_AD, this field is required.

ResponsiveSearchAdPath1 String False

The path information which complements display URL generated automatically. To specify path2, path1 is required. If adType is RESPONSIVE_SEARCH_AD, this field is required.

ResponsiveSearchAdPath2 String False

The path information which complements display URL generated automatically. If path1 is not specified, path2 will be ignored. If adType is RESPONSIVE_SEARCH_AD, this field is required.

TextAd2Description2 String False

Description2 (line2) of the ad.

TrackingUrl String False

Tracking URL.

Url String False

Destination URL before upgrading.

ApprovalStatus String False

Displays Editorial Status.

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

CampaignId Int64 False

SearchAdsCampaigns.CampaignId

Campaign ID.

CampaignName String False

Campaign name.

CampaignTrackId Int64 False

Campaign ID for tracking.

CreatedDate Date True

Date of Ad made

DisapprovalReasonCodes String False

Code of Disapproval reason.

FeedId Int64 False

SearchAdsFeeds.FeedId

Feed ID.

InvalidedTrademarks String False

Invalided trademarks.

Labels String False

Describes label information to be associated.

TrademarkStatus String False

Describes the status of trademark.

使用できる値は次のとおりです。NO_RESTRICTION, CONFLICT_WITH_TRADEMARK, CLAIM_IN_PROGRESS, DISAPPROVAL_CLAIM, DISAPPROVAL_REVIEWER, UNKNOWN

UserStatus String False

Displays ad delivery status that can be set by an user.

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

TextAd2Headline String False

Title of the ad.

TextAd2Description String False

Description of the ad.

AppAdHeadline String False

Title of the ad.

AppAdDescription String False

Description of the ad.

ExtendedTextAdHeadline String False

Title of the Ad.

ExtendedTextAdDescription String False

Description of the Ad.

DynamicSearchLinkedAdDescription String False

Description of the Ad.

DynamicSearchLinkedAdDescription2 String False

Description2 of the ad.

ResponsiveSearchAdReviewDescriptions String False

Displays the text asset for the description under review.

ResponsiveSearchAdReviewHeadlines String False

Displays the text asset for the headline under review.

ResponsiveSearchAdIsRemovePath1 String False

It is a flag for removing an information item.

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

ResponsiveSearchAdIsRemovePath2 String False

It is a flag for removing an information item (for path2).

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

ResponsiveSearchAdReviewPath1 String False

The path information which complements display URL generated automatically (Under review).

ResponsiveSearchAdReviewPath2 String False

The path information which complements display URL generated automatically (Under review).

ReviewFinalUrl String False

Landing Page URL on editorial review.

ReviewSmartphoneFinalUrl String False

Landing Page URL (Smartphone) on editorial review.

IsRemoveSmartphoneFinalUrl String False

It is a flag for removing an information item.

ReviewTrackingUrl String False

Tracking URL on editorial review.

IsReviewTrackingUrl String False

It is a flag for removing an information item.

ReviewCustomParametersIsRemove String False

Delete flag.

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

ReviewCustomParametersParameters String False

Displays the element of custom parameters.

Pseudo-Columns

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

Name Type Description
ContainsLabel Boolean

Describes acquisition flag of label data.

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

LabelIds Int64

Label Ids.

StartDate Date

This is the start date of the search target period.

EndDate Date

This is the end date of the search target period.

ReferenceNumber String

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

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