CData Python Connector for Yahoo! Ads

Build 22.0.8479

GuaranteedAdGroups

Create, Read, Update guaranteed ad group and use AdGroup/remove to delete the guaranteed 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'.
  • ContainsLabelIdFlg supports the '='.
  • LabelId supports the '=,IN'.

For example, the following queries are processed server side:

SELECT * from GuaranteedAdGroups WHERE AccountId = '123436'

INSERT

Insert can be executed by specifying the AccountId, AdGroupName, CampaignId, Device 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 GuaranteedAdGroupLabels#TEMP (Color,Description,LabelId,LabelName) VALUES ('#0000FF','Testing GuaranteedAdGroupLabels','1000158197','TestGuaranteedAdGroupLabel')
INSERT INTO GuaranteedAdGroups (AccountId,AdGroupName,CampaignId,Device,Labels,UserStatus) VALUES ('1002504155','TestGuaranteedAdGroup','8667452','DESKTOP','GuaranteedAdGroupLabels#TEMP','ACTIVE')

UPDATE

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

INSERT INTO GuaranteedAdGroupAdLabels#TEMP (Color,Description,LabelName) VALUES ('#0000FF','Updating GuaranteedAdGroupLabels','TestGuaranteedAdGroupLabel')
UPDATE GuaranteedAdGroups SET AdGroupName = 'UpdateGuaranteedAdGroup', CampaignId = '8667452',Device = 'DESKTOP',Labels = 'GuaranteedAdGroupLabels#TEMP', UserStatus = 'ACTIVE' WHERE AccountId = '123436' AND AdGroupId = '2737353'

Columns

Name Type ReadOnly References Description
AdGroupId [KEY] Int64 True

Ad Group ID.

AccountId Int64 True

DisplayAdsAccounts.AccountId

Account ID.

AdGroupName String False

Ad group name.

AdGroupTargets String False

Contains targeting information specified in ad group.

CampaignId Int64 False

GuaranteedCampaigns.CampaignId

Campaign ID.

CampaignName String False

Campaign name.

Device String False

Displays types of devices to be posted on. The allowed values are DESKTOP,SMARTPHONE,TABLET,NONE,UNKNOWN

DeviceApp String False

Serves application types for devices. The allowed values are APP,WEB,NONE,UNKNOWN

DeviceOs String False

Serves OS types for devices to be posted on. The allowed values are IOS,ANDROID,NONE,UNKNOWN

IsCreativeProfile Boolean False

If the value of this field is true, it indicates that the ad group was added using a creative profile.

Labels String False

Object describes label information to be associated.

UserStatus String False

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

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

Pseudo-Columns

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.

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