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

Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService:
Google.Api.Ads.AdManager.v202208.ILineItemCreativeAssociationService Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationServiceInterface

Public Member Functions

 LineItemCreativeAssociationService ()
 Creates a new instance of the LineItemCreativeAssociationService class. More...
 
 LineItemCreativeAssociationService (string endpointConfigurationName)
 Creates a new instance of the LineItemCreativeAssociationService class. More...
 
 LineItemCreativeAssociationService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the LineItemCreativeAssociationService class. More...
 
 LineItemCreativeAssociationService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the LineItemCreativeAssociationService class. More...
 
 LineItemCreativeAssociationService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the LineItemCreativeAssociationService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[] 
createLineItemCreativeAssociations (Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[] lineItemCreativeAssociations)
 Creates new LineItemCreativeAssociation objects More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]> 
createLineItemCreativeAssociationsAsync (Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[] lineItemCreativeAssociations)
 
virtual
Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationPage 
getLineItemCreativeAssociationsByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a LineItemCreativeAssociationPage of LineItemCreativeAssociation objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationPage
getLineItemCreativeAssociationsByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual string getPreviewUrl (long lineItemId, long creativeId, string siteUrl)
 Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. More...
 
virtual
System.Threading.Tasks.Task
< string > 
getPreviewUrlAsync (long lineItemId, long creativeId, string siteUrl)
 
virtual
Google.Api.Ads.AdManager.v202208.CreativeNativeStylePreview[] 
getPreviewUrlsForNativeStyles (long lineItemId, long creativeId, string siteUrl)
 Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. Each URL corresponds to one available native style for previewing the specified creative. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.CreativeNativeStylePreview[]> 
getPreviewUrlsForNativeStylesAsync (long lineItemId, long creativeId, string siteUrl)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performLineItemCreativeAssociationAction (Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationAction lineItemCreativeAssociationAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on LineItemCreativeAssociation objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performLineItemCreativeAssociationActionAsync (Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationAction lineItemCreativeAssociationAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
pushCreativeToDevices (Google.Api.Ads.AdManager.v202208.Statement filterStatement, Google.Api.Ads.AdManager.v202208.CreativePushOptions options)
 Pushes a creative to devices that that satisfy the given Statement::query. * More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
pushCreativeToDevicesAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement, Google.Api.Ads.AdManager.v202208.CreativePushOptions options)
 
virtual
Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[] 
updateLineItemCreativeAssociations (Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[] lineItemCreativeAssociations)
 Updates the specified LineItemCreativeAssociation objects More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]> 
updateLineItemCreativeAssociationsAsync (Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[] lineItemCreativeAssociations)
 

Detailed Description

Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects.

A line item creative association (LICA) associates a Creative with a LineItem. When a line item is selected to serve, the LICAs specify which creatives can appear for the ad units that are targeted by the line item. In order to be associated with a line item, the creative must have a size that exists within the attribute LineItem::creativePlaceholders.

Each LICA has a start and end date and time that defines when the creative should be displayed.

To read more about associating creatives with line items, see this DFP Help Center article.

Constructor & Destructor Documentation

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

Creates a new instance of the LineItemCreativeAssociationService class.

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

Creates a new instance of the LineItemCreativeAssociationService class.

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

Creates a new instance of the LineItemCreativeAssociationService class.

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

Creates a new instance of the LineItemCreativeAssociationService class.

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

Creates a new instance of the LineItemCreativeAssociationService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation [] Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.createLineItemCreativeAssociations ( Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]  lineItemCreativeAssociations)
inlinevirtual

Creates new LineItemCreativeAssociation objects

Parameters
lineItemCreativeAssociationsthe line item creative associations to create
Returns
the created line item creative associations with their IDs filled in

Implements Google.Api.Ads.AdManager.v202208.ILineItemCreativeAssociationService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.createLineItemCreativeAssociationsAsync ( Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]  lineItemCreativeAssociations)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationPage Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

Gets a LineItemCreativeAssociationPage of LineItemCreativeAssociation objects that satisfy the given Statement::query. The following fields are supported for filtering:

PQL Property Object Property
creativeId LineItemCreativeAssociation::creativeId
manualCreativeRotationWeight LineItemCreativeAssociation::manualCreativeRotationWeight
destinationUrl LineItemCreativeAssociation::destinationUrl
lineItemId LineItemCreativeAssociation::lineItemId
status LineItemCreativeAssociation::status
lastModifiedDateTime LineItemCreativeAssociation::lastModifiedDateTime
Parameters
filterStatementa Publisher Query Language statement used to filter a set of line item creative associations
Returns
the line item creative associations that match the given filter

Implements Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationPage> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual string Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.getPreviewUrl ( long  lineItemId,
long  creativeId,
string  siteUrl 
)
inlinevirtual

Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id.

Parameters
lineItemIdthe ID of the line item, which must already exist
creativeIdthe ID of the creative, which must already exist
siteUrlthe URL of the site that the creative should be previewed in
Returns
a URL that references the specified site URL with the specified creative served to it

Implements Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationServiceInterface.

virtual System.Threading.Tasks.Task<string> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.getPreviewUrlAsync ( long  lineItemId,
long  creativeId,
string  siteUrl 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.CreativeNativeStylePreview [] Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.getPreviewUrlsForNativeStyles ( long  lineItemId,
long  creativeId,
string  siteUrl 
)
inlinevirtual

Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. Each URL corresponds to one available native style for previewing the specified creative.

Parameters
lineItemIdthe ID of the line item, which must already exist
creativeIdthe ID of the creative, which must already exist and must be a native creative
siteUrlthe URL of the site that the creative should be previewed in
Returns
the URLs that references the specified site URL and can be used to preview the specified creative with the available native styles

Implements Google.Api.Ads.AdManager.v202208.ILineItemCreativeAssociationService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.CreativeNativeStylePreview[]> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.getPreviewUrlsForNativeStylesAsync ( long  lineItemId,
long  creativeId,
string  siteUrl 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.performLineItemCreativeAssociationAction ( Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationAction  lineItemCreativeAssociationAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

Performs actions on LineItemCreativeAssociation objects that match the given Statement::query.

Parameters
lineItemCreativeAssociationActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of line item creative associations
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.performLineItemCreativeAssociationActionAsync ( Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationAction  lineItemCreativeAssociationAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.pushCreativeToDevices ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement,
Google.Api.Ads.AdManager.v202208.CreativePushOptions  options 
)
inlinevirtual

Pushes a creative to devices that that satisfy the given Statement::query. *

Parameters
filterStatementa Publisher Query Language statement on the ID, Name, UserId and LinkedDeviceVisibility fields of the LinkedDevice table.
optionscriteria to use to push a given creative.

Implements Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.pushCreativeToDevicesAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement,
Google.Api.Ads.AdManager.v202208.CreativePushOptions  options 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation [] Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.updateLineItemCreativeAssociations ( Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]  lineItemCreativeAssociations)
inlinevirtual

Updates the specified LineItemCreativeAssociation objects

Parameters
lineItemCreativeAssociationsthe line item creative associations to update
Returns
the updated line item creative associations

Implements Google.Api.Ads.AdManager.v202208.ILineItemCreativeAssociationService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]> Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociationService.updateLineItemCreativeAssociationsAsync ( Google.Api.Ads.AdManager.v202208.LineItemCreativeAssociation[]  lineItemCreativeAssociations)
inlinevirtual

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