Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.admanager.jaxws.v202402;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;
/**
*
* Provides methods for executing a PQL {@link Statement} to retrieve information from the system.
* In order to support the selection of columns of interest from various tables, {@link Statement}
* objects support a "select" clause.
*
*
An example query text might be {@code "select CountryCode, Name from Geo_Target"}, where
* {@code CountryCode} and {@code Name} are columns of interest and {@code 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 {@code LineItem}.
CreationDateTime
Datetime
The date and time this {@code LineItem} was last created. This attribute may be null for {@code LineItem}s created before this feature was introduced.
DeliveryRateType
Text
The strategy for delivering ads over the course of the {@code LineItem}'s duration. This attribute is optional and defaults to {@link DeliveryRateType#EVENLY}. Starting in v201306, it may default to {@link DeliveryRateType#FRONTLOADED} if specifically configured to on the network.
EndDateTime
Datetime
The date and time on which the {@code LineItem} stops serving.
ExternalId
Text
An identifier for the {@code LineItem} that is meaningful to the publisher.
Id
Number
Uniquely identifies the {@code LineItem}. This attribute is read-only and is assigned by Google when a line item is created.
IsMissingCreatives
Boolean
Indicates if a {@code LineItem} is missing any {@link Creative creatives} for the {@code creativePlaceholders} specified.
IsSetTopBoxEnabled
Boolean
Whether or not this line item is set-top box enabled.
LastModifiedDateTime
Datetime
The date and time this {@code LineItem} was last modified.
LatestNielsenInTargetRatioMilliPercent
Number
The most recently computed in-target ratio measured from Nielsen reporting data and the {@code LineItem}'s settings. It's provided in milli percent, or null if not applicable.
LineItemType
Text
Indicates the line item type of a {@code LineItem}.
Name
Text
The name of the {@code LineItem}.
OrderId
Number
The ID of the {@link Order} to which the {@code LineItem} belongs.
StartDateTime
Datetime
The date and time on which the {@code LineItem} is enabled to begin serving.
Status
Text
The status of the {@code 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 {@code LineItem}. If the line item is of type {@link 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 {@link AdUnit 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. {@link Role} objects that are created by Google will have negative IDs.
RoleName
Text
The name of the {@link 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.
IsAgency
Boolean
Whether the buyer is an advertising agency.
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 {@code America/New_York}.
StandardGmtOffset
Text
The standard GMT offset in current time in the form of {@code GMT-05:00} for {@code America/New_York}, excluding the Daylight Saving Time.
Proposal_Terms_And_Conditions
Column name
Type
Description
Change_History
Restrictions: Only ordering by {@code ChangeDateTime} descending is supported. The {@code IN} operator is only supported on the {@code entityType} column. {@code OFFSET} is not supported. To page through results, filter on the earliest change {@code Id} as a continuation token. For example {@code "WHERE Id < :id"}. On each query, both an upper bound and a lower bound for the {@code ChangeDateTime} 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 {@link ChangeHistoryEntityType type} of the entity that was changed.
Id
Text
The ID of this change. IDs may only be used with {@code "<"} operator for paging and are subject to change. Do not store IDs. Note that the {@code "<"} here does not compare the value of the ID but the row in the change history table it represents.
Operation
Text
The {@link ChangeHistoryOperation operation} that was performed on this entity.
UserId
Number
The {@link User#id 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
The global set of rich media ad companies that are known to Google.
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')"). Bydefault, child publishers are ordered by their network code.
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 {@link 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 {@code 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 {@link code 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 {@code TotalEarningsCurrencyCode}.
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
By default, child publishers are ordered by their ID.
Column name
Type
Description
AccountStatus
Text
The account status of the child publisher's Ad Manager network. Deprecated and replaced by the AccountStatus column. Possible values are {$code INVITED}, {$code DECLINED}, {$code APPROVED}, {$code CLOSED_BY_PUBLISHER}, {$code CLOSED_INVALID_ACTIVITY}, {$code CLOSED_POLICY_VIOLATION}, {$code DEACTIVATED_BY_AD_MANAGER}, {$code DISAPPROVED_DUPLICATE_ACCOUNT}, {$code DISAPPROVED_INELIGIBLE}, {$code PENDING_GOOGLE_APPROVAL}, {$code EXPIRED}, and {$code INACTIVE}.
AddressVerificationExpirationTime
Datetime
Date when the child publisher's address verification (mail PIN) will expire.
AddressVerificationLastModifiedTime
Datetime
The time of the last change in the child publisher's address verification (mail PIN) process.
AddressVerificationStatus
Text
The address verification (mail PIN) status of the child publisher's Ad Manager network. Possible values are {$code EXEMPT}, {$code EXPIRED}, {$code FAILED}, {$code PENDING}, {$code NOT_ELIGIBLE}, and {$code VERIFIED}.
AgreementStatus
Text
Status of the delegation relationship between parent and child. Deprecated and replaced by the InvitationStatus column. Possible values are {$code APPROVED}, {$code PENDING}, {$code REJECTED}, {$code WITHDRAWN}.
ApprovalStatus
Text
The approval status of the child publisher's Ad Manager network. Possible values are {$code APPROVED}, {$code CLOSED_BY_PUBLISHER}, {$code CLOSED_INVALID_ACTIVITY}, {$code CLOSED_POLICY_VIOLATION}, {$code DEACTIVATED_BY_AD_MANAGER}, {$code DISAPPROVED_DUPLICATE_ACCOUNT}, {$code DISAPPROVED_INELIGIBLE}, and {$code PENDING_GOOGLE_APPROVAL}.
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.
IdentityVerificationLastModifiedTime
Datetime
The time of the last change in the child publisher's identity verification process.
IdentityVerificationStatus
Text
Status of the child publisher's identity verification process. Possible values are {$code EXEMPT}, {$code EXPIRED}, {$code FAILED}, {$code PENDING}, {$code NOT_ELIGIBLE}, and {$code VERIFIED}.
InvitationStatus
Text
Status of the parent's invitation request to a child publisher. Possible values are {$code ACCEPTED}, {$code EXPIRED}, {$code PENDING}, {$code REJECTED}, and {$code WITHDRAWN}.
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 {@code AccountStatus} is {@code PENDING_GOOGLE_APPROVAL}.
ReadinessStatus
Text
Overall onboarding readiness of the child publisher. Correlates with serving behavior, but does not include site-level approval information. Possible values are {$code READY}, {$code NOT_READY}, and {$code INACTIVE}.
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.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.3.0.2
* Generated source version: 2.1
*
*/
@WebService(name = "PublisherQueryLanguageServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@XmlSeeAlso({
ObjectFactory.class
})
public interface PublisherQueryLanguageServiceInterface {
/**
*
* Retrieves rows of data that satisfy the given {@link Statement#query} from the system.
*
*
* @param selectStatement
* @return
* returns com.google.api.ads.admanager.jaxws.v202402.ResultSet
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
@RequestWrapper(localName = "select", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.PublisherQueryLanguageServiceInterfaceselect")
@ResponseWrapper(localName = "selectResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402", className = "com.google.api.ads.admanager.jaxws.v202402.PublisherQueryLanguageServiceInterfaceselectResponse")
public ResultSet select(
@WebParam(name = "selectStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v202402")
Statement selectStatement)
throws ApiException_Exception
;
}
