• Home
• com.google.api-ads
• dfp-appengine
• 2.14.0
• source code
• PublisherQueryLanguageServiceInterface.java

×

Project download

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.

com.google.api.ads.dfp.jaxws.v201602.PublisherQueryLanguageServiceInterface Maven / Gradle / Ivy

package com.google.api.ads.dfp.jaxws.v201602;

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
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
 *       
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.
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.<p>
 * <b>This object is experimental!
 * <code>Targeting</code> is an experimental, innovative, and rapidly
 * changing new feature for DFP. Unfortunately, being on the bleeding edge means that we may make
 * backwards-incompatible changes to
 * <code>Targeting</code>. We will inform the community when this feature
 * is no longer experimental.</b>
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.
PartnerId
Number
The unique ID of the {@link Company}, which is of type {@link Company.Type#AFFILIATE_DISTRIBUTION_PARTNER}, to which this ad unit belongs.
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.
Exchange_Rate
Column name
Type
Description
CurrencyCode
Text
The currency code that the exchange rate is related to. The exchange rate is between this currency and {@link Network#currencyCode the network's currency}. This attribute is required for creation and then is readonly.
Direction
Text
The direction that the exchange rate is in. It determines whether the exchange rate is from this currency to {@link Network#currencyCode the network's currency}, or from {@link Network#currencyCode the network's currency} to this currency. This attribute can be updated.
ExchangeRate
Number
The latest exchange rate at current refresh rate and in current direction. The value is stored as the exchange rate times 10,000,000,000 truncated to a long. Setting this attribute requires the refresh rate to be already set to {@link ExchangeRateRefreshRate#FIXED}. Otherwise an exception will be thrown.
Id
Number
The ID of the {@code ExchangeRate}. This attribute is readonly and is assigned by Google when an exchange rate is created.
RefreshRate
Text
The refresh rate at which the exchange rate is updated. Setting this attribute to {@link ExchangeRateRefreshRate#FIXED} without setting the exchange rate value will cause unknown exchange rate value returned in future queries.
Programmatic_Buyer
Column name
Type
Description
AdxBuyerNetworkId
Number
The ID used by Adx to bill the appropriate buyer network for a programmatic order.
BuyerId
Number
The ID used by the buyer for their billing reference. This may represent either an Advertiser or Partner ID.
Name
Text
Display name that references the buyer.
ParentId
Number
The ID of the programmatic buyer's parent. For advertisers, this field contains the advertiser's partner ID. For partners, this field is zero.
Type
Text
The type of a programmatic buyer.
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
CategoryIds
Set of number
The ids of the categories that this audience segment belongs to.
Id
Number
The unique identifier for the audience 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.
SegmentType
Text
The type of the audience segment.
Proposal_Retraction_Reason
Column name
Type
Description
Id
Number
The ID of the {@code ProposalRetractionReason}. This attribute is readonly and is assigned by Google when a proposal retraction reason is created.
IsActive
Boolean
True if the {@code ProposalRetractionReason} is active.
Name
Text
The name of the {@code ProposalRetractionReason}.
Audience_Explorer
Column name
Type
Description
Id
Number
Uniquely identifies the audience segment.
ThirtyDayActiveSize
Number
The number of active unique cookies in this segment over the last 30 days.
ThirtyDayClicks
Number
The number of clicks for this segment over the last 30 days.
ThirtyDayImpressions
Number
The number of impressions for this segment over the last 30 days.
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
Content
Text
The content of the terms and conditions.
Id
Number
Uniquely identifies the terms and conditions.
IsDefault
Boolean
Whether or not this set of terms and conditions are the default for a network.
LastModifiedDateTime
Datetime
The date and time this terms and conditions was last modified.
Name
Text
The name of the terms and conditions.
 *     
 * 
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.2.9-b130926.1035
 * Generated source version: 2.1
 * 
 */
@WebService(name = "PublisherQueryLanguageServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface PublisherQueryLanguageServiceInterface {


    /**
     * 
     *         Retrieves rows of data that satisfy the given {@link Statement#query} from
     *         the system.
     *         
     *         @param selectStatement a Publisher Query Language statement used to
     *         specify what data needs to returned
     *         
     *         @return a result set of data that matches the given filter
     *       
     * 
     * @param selectStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201602.ResultSet
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
    @RequestWrapper(localName = "select", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PublisherQueryLanguageServiceInterfaceselect")
    @ResponseWrapper(localName = "selectResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PublisherQueryLanguageServiceInterfaceselectResponse")
    public ResultSet select(
        @WebParam(name = "selectStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
        Statement selectStatement)
        throws ApiException_Exception
    ;

}