CData Python Connector for Yahoo! Ads

Build 22.0.8479

SearchAdsAdGroups

Create, Read, Update or Delete Ad group.

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'.
  • CampaignId supports the '=,IN'.
  • UserStatus supports the '=,IN'.
  • ContainsLabelId supports the '=,IN'.
  • BiddingStateryIds supports the '=,IN'.
  • LabelId supports the '=,IN'.
  • StartDate supports the '='.
  • EndDate supports the '='.

For example, the following queries are processed server side:

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '1234339'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '1234339' AND AdGroupId = '303253202'

SELECT * FROM SearchAdsAdGroupAds WHERE AccountId = '1234339' AND CampaignId = '303253202'

INSERT

Insert can be executed by specifying the AccountId, AdGroupId, AdGroupName, CampaignId, CustomParameters, UrlReviewDataInReviewUrlParameters and UserStatus columns. The columns that are not read-only can be inserted optionally. For example:

 INSERT INTO customparameters#TEMP (Key, value) VALUES ('TestKey', 'TestValue')
 INSERT INTO urlparameters#TEMP (Key, value) VALUES ('TestKey2', 'TestValue2')
 INSERT INTO SearchAdsAdGroups (AccountId, AdGroupName,CampaignId, CustomParameters, UserStatus, UrlReviewDataInReviewUrlParameters ) VALUES ('1234339', 'TestGroupName', '1833923','customparameters#TEMP', 'ACTIVE', 'urlparameters#TEMP')
 

UPDATE

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

INSERT INTO urlparameters#TEMP (Key, value) VALUES ('TestKey2', 'TestValue2')
UPDATE SearchAdsAdGroups SET AdGroupName = 'TestName', SettingsTargetingSettingTargetAll = 'ACTIVE', UrlReviewDataInReviewUrlParameters = 'urlparameters#TEMP', SettingsCriterionType = 'TARGET_LIST'  WHERE AccountId = '1234339' AND AdGroupId = '303253202' AND CampaignId = '1833923'

DELETE

Delete can be executed by specifying the AccountId and adGroupId in the WHERE Clause. For example:

Delete from SearchAdsAdGroups  WHERE AccountId = '1234339' AND CampaignId = '1833923' AND AdGroupId = '303253202'

Columns

Name Type ReadOnly References Description
AdGroupId [KEY] Int64 True

Ad group ID.

AccountId Int64 True

SearchAdsAccounts.AccountId

Account ID.

AdGroupAdRotationModeAdRotationMode String False

Describes Ad Rotation settings for optimizing and displaying ads.

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

AdGroupName String False

Ad Group name.

AdGroupTrackId Int64 False

Ad Group ID for tracking.

BidBidSource String False

Displays which level bid belongs to ad group.

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

BidCpc Int64 False

Keyword bid (CPC).The default value in ADD operation will be 1.

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です。

TargetCpaOverride Int64 False

Target CPA.

TargetRoasOverride String False

Target ROAS.

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

Pseudo-Columns

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

Name Type Description
BiddingStateryIds Int64

Bidding Statery Ids.

ContainsLabelId String

Describes acquisition flag of label data.

LabelId Int64

Label Ids.

StartDate Date

This is the start date of the search target period.

EndDate Date

This is the end date of the search target period.

Min String

Maximum value of the search range.

Max String

Minimum value of the search range.

ReferenceNumber String

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

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