Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService Class Reference

Provides methods for executing a PQL Statement to retrieve information from the system. In order to support the selection of columns of interest from various tables, Statement objects support a "select" clause. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService:
Google.Api.Ads.AdManager.v202208.IPublisherQueryLanguageService Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageServiceInterface

Public Member Functions

 PublisherQueryLanguageService ()
 Creates a new instance of the PublisherQueryLanguageService class. More...
 
 PublisherQueryLanguageService (string endpointConfigurationName)
 Creates a new instance of the PublisherQueryLanguageService class. More...
 
 PublisherQueryLanguageService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the PublisherQueryLanguageService class. More...
 
 PublisherQueryLanguageService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the PublisherQueryLanguageService class. More...
 
 PublisherQueryLanguageService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the PublisherQueryLanguageService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.ResultSet 
select (Google.Api.Ads.AdManager.v202208.Statement selectStatement)
 Retrieves rows of data that satisfy the given Statement::query from the system. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.ResultSet
selectAsync (Google.Api.Ads.AdManager.v202208.Statement selectStatement)
 

Detailed Description

Provides methods for executing a PQL Statement to retrieve information from the system. In order to support the selection of columns of interest from various tables, Statement objects support a "select" clause.

An example query text might be "select CountryCode, Name from Geo_Target", where CountryCode and Name are columns of interest and Geo_Target is the table.

The following tables are supported:

Geo_Target

Column Name Description
Id Unique identifier for the Geo target
Name The name of the Geo target
CanonicalParentId The criteria ID of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonicalParentId would be the criteria ID of California and the canonicalParentId of California would be the criteria ID of United states
ParentIds A comma separated list of criteria IDs of all parents of the geo target ordered by ascending size
CountryCode Country code as defined by ISO 3166-1 alpha-2
Type Allowable values:
  • Airport
  • Autonomous_Community
  • Canton
  • City
  • Congressional_District
  • Country
  • County
  • Department
  • DMA_Region
  • Governorate
  • Municipality
  • Neighborhood
  • Postal_Code
  • Prefecture
  • Province
  • Region
  • State
  • Territory
  • Tv_Region
  • Union_Territory
Targetable Indicates whether geographical targeting is allowed

Bandwidth_Group

Column Name Description
Id Unique identifier for the bandwidth group
BandwidthName Name of the bandwidth group

Browser

Note: this table only contains browsers that are available in the Ad Manager UI targeting picker.

Column Name Description
Id Unique identifier for the browser
BrowserName Name of the browser
MajorVersion Major version of the browser
MinorVersion Minor version of the browser

Browser_Language

Column Name Description
Id Unique identifier for the browser language
BrowserLanguageName Browser's language

Device_Capability

Column Name Description
Id Unique identifier for the device capability
DeviceCapabilityName Name of the device capability

Device_Category

Column Name Description
Id Unique identifier for the device category
DeviceCategoryName Name of the device category

Device_Manufacturer

Column Name Description
Id Unique identifier for the device manufacturer
MobileDeviceManufacturerName Name of the device manufacturer

Mobile_Carrier

Column Name Description
Id Unique identifier for the mobile carrier
CountryCode The country code of the mobile carrier
MobileCarrierName Name of the mobile carrier

Mobile_Device

Column Name Description
Id Unique identifier for the mobile device
MobileDeviceManufacturerId Id of the device manufacturer
MobileDeviceName Name of the mobile device

Mobile_Device_Submodel

Column Name Description
Id Unique identifier for the mobile device submodel
MobileDeviceId Id of the mobile device
MobileDeviceSubmodelName Name of the mobile device submodel

Operating_System

Column Name Description
Id Unique identifier for the operating system
OperatingSystemName Name of the operating system

Operating_System_Version

Column Name Description
Id Unique identifier for the operating system version
OperatingSystemId Id of the operating system
MajorVersion The operating system major version
MinorVersion The operating system minor version
MicroVersion The operating system micro version

Third_Party_Company

Column Name Description
Id Unique identifier for the third party company
Name The third party company name
Type The third party company type
Status The status of the third party company

Line_Item

Column name Type Description
CostType Text The method used for billing this LineItem.
CreationDateTime Datetime The date and time this LineItem was last created. This attribute may be null for LineItems created before this feature was introduced.
DeliveryRateType Text The strategy for delivering ads over the course of the 's duration. This attribute is optional and defaults to DeliveryRateType::EVENLY. Starting in v201306, it may default to DeliveryRateType::FRONTLOADED if specifically configured to on the network.
EndDateTime Datetime The date and time on which the LineItem stops serving.
ExternalId Text An identifier for the LineItem that is meaningful to the publisher.
Id Number Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.
IsMissingCreatives Boolean Indicates if a LineItem is missing any creatives for the creativePlaceholders specified.
IsSetTopBoxEnabled Boolean Whether or not this line item is set-top box enabled.
LastModifiedDateTime Datetime The date and time this LineItem was last modified.
LatestNielsenInTargetRatioMilliPercent Number The most recently computed in-target ratio measured from Nielsen reporting data and the LineItem's settings. It's provided in milli percent, or null if not applicable.
LineItemType Text Indicates the line item type of a LineItem.
Name Text The name of the LineItem.
OrderId Number The ID of the Order to which the belongs.
StartDateTime Datetime The date and time on which the LineItem is enabled to begin serving.
Status Text The status of the LineItem.
Targeting Targeting The targeting criteria for the ad campaign.
UnitsBought Number The total number of impressions or clicks that will be reserved for the LineItem. If the line item is of type LineItemType::SPONSORSHIP, then it represents the percentage of available impressions reserved.

Ad_Unit

Column name Type Description
AdUnitCode Text A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
ExternalSetTopBoxChannelId Text The channel ID for set-top box enabled ad units.
Id Number Uniquely identifies the ad unit. This value is read-only and is assigned by Google when an ad unit is created.
LastModifiedDateTime Datetime The date and time this ad unit was last modified.
Name Text The name of the ad unit.
ParentId Number The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google.

User

Column name Type Description
Email Text The email or login of the user.
ExternalId Text An identifier for the user that is meaningful to the publisher.
Id Number The unique ID of the user.
IsServiceAccount Boolean True if this user is an OAuth2 service account user, false otherwise.
Name Text The name of the user.
RoleId Number The unique role ID of the user. Role objects that are created by Google will have negative IDs.
RoleName Text The name of the Role assigned to the user.

Programmatic_Buyer

Column name Type Description
BuyerAccountId Number The ID used by Authorized Buyers to bill the appropriate buyer network for a programmatic order.
EnabledForPreferredDeals Boolean Whether the buyer is allowed to negotiate Preferred Deals.
EnabledForProgrammaticGuaranteed Boolean Whether the buyer is enabled for Programmatic Guaranteed deals.
Name Text Display name that references the buyer.
ParentId Number The ID of the programmatic buyer's sponsor. If the programmatic buyer has no sponsor, this field will be -1.
PartnerClientId Text ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

Audience_Segment_Category

Column name Type Description
Id Number The unique identifier for the audience segment category.
Name Text The name of the audience segment category.
ParentId Number The unique identifier of the audience segment category's parent.

Audience_Segment

Column name Type Description
AdIdSize Number The number of AdID users in the segment.
CategoryIds Set of number The ids of the categories that this audience segment belongs to.
Id Number The unique identifier for the audience segment.
IdfaSize Number The number of IDFA users in the segment.
MobileWebSize Number The number of mobile web users in the segment.
Name Text The name of the audience segment.
OwnerAccountId Number The owner account id of the audience segment.
OwnerName Text The owner name of the audience segment.
PpidSize Number The number of PPID users in the segment.
SegmentType Text The type of the audience segment.

Time_Zone

Column name Type Description
Id Text The id of time zone in the form of .
StandardGmtOffset Text The standard GMT offset in current time in the form of for America/New_York, excluding the Daylight Saving Time.

Proposal_Terms_And_Conditions

Column name Type Description

Change_History

Restrictions: Only ordering by ChangeDateTime descending is supported. The IN operator is only supported on the column. OFFSET is not supported. To page through results, filter on the earliest change Id as a continuation token. For example "WHERE Id &lt; :id". On each query, both an upper bound and a lower bound for the are required.

Column name Type Description
ChangeDateTime Datetime The date and time this change happened.
EntityId Number The ID of the entity that was changed.
EntityType Text The type of the entity that was changed.
Id Text The ID of this change. IDs may only be used with "&lt;" operator for paging and are subject to change. Do not store IDs. Note that the "&lt;" here does not compare the value of the ID but the row in the change history table it represents.
Operation Text The operation that was performed on this entity.
UserId Number The ID of the user that made this change.

ad_category

Column name Type Description
ChildIds Set of number Child IDs of an Ad category. Only general categories have children
Id Number ID of an Ad category
Name Text Localized name of an Ad category
ParentId Number Parent ID of an Ad category. Only general categories have parents
Type Text Type of an Ad category. Only general categories have children

rich_media_ad_company

Column name Type Description
CompanyGvlId Number IAB Global Vendor List ID of a Rich Media Ad Company
GdprStatus Text GDPR compliance status of a Rich Media Ad Company. Indicates whether the company has been registered with Google as a compliant company for GDPR.
Id Number ID of a Rich Media Ad Company
Name Text Name of a Rich Media Ad Company
PolicyUrl Text Policy URL of a Rich Media Ad Company

mcm_earnings

Restriction: On each query, an expression scoping the MCM earnings to a single month is required (e.x. "WHERE month = '2020-01'" or "WHERE month IN ('2020-01')").

Column name Type Description
ChildName Text The name of the child publisher.
ChildNetworkCode Text The network code of the child publisher.
ChildPaymentCurrencyCode Text The child payment currency code as defined by ISO 4217.
ChildPaymentMicros Number The portion of the total earnings paid to the child publisher in micro units of the ChildPaymentCurrencyCode
DeductionsCurrencyCode Text The deductions currency code as defined by ISO 4217. Null for earnings prior to August 2020.
DeductionsMicros Number The deductions for the month due to spam in micro units of the DeductionsCurrencyCode. Null for earnings prior to August 2020.
DelegationType Text The current type of MCM delegation between the parent and child publisher.
Month Date The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.
ParentName Text The name of the parent publisher.
ParentNetworkCode Text The network code of the parent publisher.
ParentPaymentCurrencyCode Text The parent payment currency code as defined by ISO 4217.
ParentPaymentMicros Number The portion of the total earnings paid to the parent publisher in micro units of the ParentPaymentCurrencyCode.
TotalEarningsCurrencyCode Text The total earnings currency code as defined by ISO 4217.
TotalEarningsMicros Number The total earnings for the month in micro units of the .

Linked_Device

Column name Type Description
Id Number The ID of the LinkedDevice
Name Text The name of the LinkedDevice
UserId Number The ID of the user that this device belongs to.
Visibility Text The visibility of the LinkedDevice.

child_publisher

Column name Type Description
AccountStatus Text The account status of the MCM child publisher's Ad Manager network
AgreementStatus Text Status of the delegation relationship between parent and child.
ApprovedManageAccountRevshareMillipercent Number The approved revshare with the MCM child publisher
ChildNetworkAdExchangeEnabled Boolean Whether the child publisher's Ad Manager network has Ad Exchange enabled
ChildNetworkCode Text The network code of the MCM child publisher
DelegationType Text The delegation type of the MCM child publisher. This will be the approved type if the child has accepted the relationship, and the proposed type otherwise.
Email Text The email of the MCM child publisher
Id Number The ID of the MCM child publisher
Name Text The name of the MCM child publisher
OnboardingTasks Set of text The child publisher's pending onboarding tasks. This will only be populated if the child publisher's AccountStatus is PENDING_GOOGLE_APPROVAL.
SellerId Text The child publisher's seller ID, as specified in the parent publisher's sellers.json file. This field is only relevant for Manage Inventory child publishers.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.PublisherQueryLanguageService ( )
inline

Creates a new instance of the PublisherQueryLanguageService class.

Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.PublisherQueryLanguageService ( string  endpointConfigurationName)
inline

Creates a new instance of the PublisherQueryLanguageService class.

Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.PublisherQueryLanguageService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the PublisherQueryLanguageService class.

Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.PublisherQueryLanguageService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the PublisherQueryLanguageService class.

Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.PublisherQueryLanguageService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the PublisherQueryLanguageService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.ResultSet Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.select ( Google.Api.Ads.AdManager.v202208.Statement  selectStatement)
inlinevirtual

Retrieves rows of data that satisfy the given Statement::query from the system.

Parameters
selectStatementa Publisher Query Language statement used to specify what data needs to returned
Returns
a result set of data that matches the given filter

Implements Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.ResultSet> Google.Api.Ads.AdManager.v202208.PublisherQueryLanguageService.selectAsync ( Google.Api.Ads.AdManager.v202208.Statement  selectStatement)
inlinevirtual

The documentation for this class was generated from the following file: