Google Ad Manager Connector Objects
| Name | Description |
|---|---|
| Companies | Create, update, and query DoubleClick for Publishers Companies. |
| Contacts | Create, update, and query DoubleClick for Publishers Contacts. |
| Creatives | Update and query DoubleClick for Publishers Creatives. |
| CustomFields | Create, update, and query DoubleClick for Publishers Custom Fields. |
| CustomTargetingKeys | Create, update, and query DoubleClick for Publishers Custom Targeting Keys. |
| CustomTargetingValues | Create, update, and query DoubleClick for Publishers Custom Targeting Values. |
| DeliveryReport | Query DoubleClick for Publishers Delivery Reports. |
| Inventories | Create, update, and query DoubleClick for Publishers Inventories. |
| InventoryReport | A template inventory report. |
| Labels | Create, update, delete, and query DoubleClick for Publishers Labels. |
| LineItemCreativeAssociations | Query DoubleClick for Publishers LineItemCreativeAssociations. |
| LineItems | Create, update, delete, and query DoubleClick for Publishers Line Items. |
| MobileApplications | Create and query DoubleClick for Publishers Mobile Applications. |
| Orders | Create, update, delete, and query DoubleClick for Publishers Orders. |
| Placements | Create, update, delete, and query DoubleClick for Publishers Placements. |
| ProposalLineItems | Create, update, and query DoubleClick for Publishers ProposalLineItems. |
| Proposals | Create, update, and query DoubleClick for Publishers Proposals. |
| Roles | Query DoubleClick for Publishers Roles. |
| SalesReport | A template sales report. |
| Users | Create, update, delete, and query DoubleClick for Publishers Users. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | Uniquely identifies the Company. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates. | |
| Name | String | False | No | The full name of the company. This attribute is required and has a maximum length of 127 characters. | |
| Type | String | False | No | Specifies what kind of company this is. This attribute is required. | |
| Address | String | False | No | Specifies the address of the company. This attribute is optional and has a maximum length of 65,535 characters. | |
| String | False | No | Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters. | ||
| FaxPhone | String | False | No | Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters. | |
| PrimaryPhone | String | False | No | Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters. | |
| ExternalId | String | False | No | Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters. | |
| Comment | String | False | No | Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters. | |
| CreditStatus | String | False | No | Specifies the company's credit status. This attribute is optional and defaults to CreditStatus.ACTIVE when basic credit status settings are enabled, and CreditStatus.ON_HOLD when advanced credit status settings are enabled. | |
| Settings | String | False | No | Specifies the default billing settings of this Company. This attribute is optional. | |
| AppliedLabels | String | False | No | The set of labels applied to this company. | |
| PrimaryContactId | Long | False | No | The ID of the Contact who is acting as the primary contact for this company. This attribute is optional. | |
| AppliedTeamIds | String | False | No | The IDs of all teams that this company is on directly. | |
| ThirdPartyCompanyId | Int | False | No | Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this company was last modified. | |
| ChildPublisher | String | False | No | Info required for when Company Type is CHILD_PUBLISHER. | |
| ViewabilityProvider | String | False | No | Info required for when Company Type is VIEWABILITY_PROVIDER. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | The unique ID of the Contact. This value is readonly and is assigned by Google. | |
| Name | String | False | No | The name of the contact. This attribute is required and has a maximum length of 127 characters. | |
| CompanyId | Long | False | No | The ID of the Company that this contact is associated with. This attribute is required and immutable. | |
| Status | String | True | No | The status of the contact. This attribute is readonly and is assigned by Google. | |
| Address | String | False | No | The address of the contact. This attribute is optional and has a maximum length of 1024 characters. | |
| CellPhone | String | False | No | The cell phone number where the contact can be reached. This attribute is optional. | |
| Comment | String | False | No | A free-form text comment for the contact. This attribute is optional and has a maximum length of 1024 characters. | |
| String | False | No | The e-mail address where the contact can be reached. This attribute is optional. | ||
| FaxPhone | String | False | No | The fax number where the contact can be reached. This attribute is optional. | |
| Title | String | False | No | The job title of the contact. This attribute is optional and has a maximum length of 1024 characters. | |
| WorkPhone | String | False | No | The work phone number where the contact can be reached. This attribute is optional. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| AdvertiserId | Long | False | Companies.Id | No | The ID of the advertiser that owns the creative. This attribute is required. |
| Id [KEY] | Long | True | No | Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates. | |
| Name | String | False | No | The name of the creative. This attribute is required and has a maximum length of 255 characters. | |
| Width | Int | False | No | The width of the Creative. | |
| Height | Int | False | No | The height of the Creative. | |
| IsAspectRatio | Bool | False | No | Whether the size defined by height and width represents an aspect ratio. | |
| PreviewUrl | String | True | No | The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created. | |
| PolicyLabels | String | True | No | Set of policy labels detected for this creative. This attribute is read-only. | |
| AppliedLabels | String | False | No | The set of labels applied to this creative. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this creative was last modified. | |
| ThirdPartyDataDeclaration | String | False | No | The third party companies associated with this creative. This is distinct from any associated companies that Google may detect programmatically. | |
| Snippet | String | True | No | The HTML snippet that this creative delivers. This attribute is required. | |
| ExpandedSnippet | String | True | No | The HTML snippet that this creative delivers with macros expanded. This attribute is read-only and is set by Google. | |
| CreativeTemplateVariableValues | String | False | No | Stores values of CreativeTemplateVariable in the CreativeTemplate. | |
| SslScanResult | String | True | No | The SSL compatibility scan result for this creative. | |
| SslManualOverride | String | False | No | The manual override for the SSL compatibility of this creative. This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE. | |
| LockedOrientation | String | True | No | A locked orientation for this creative to be displayed in. | |
| AssetSize | String | True | No | The asset size of an internal redirect creative. Note that this may differ from size if users set overrideSize to true. This attribute is read-only and is populated by Google. | |
| InternalRedirectUrl | String | False | No | The internal redirect URL of the DFA or DART for Publishers hosted creative. This attribute has a maximum length of 1024 characters. | |
| IsSafeFrameCompatible | Bool | True | No | Whether the Creative is compatible for SafeFrame rendering. | |
| Html5Asset | String | False | No | The HTML5 asset. To preview the HTML5 asset, use the CreativeAsset.assetUrl. In this field, the CreativeAsset.assetByteArray must be a zip bundle and the CreativeAsset.fileName must have a zip extension. | |
| DestinationUrl | String | False | No | The URL the user is directed to if they click on the creative. This attribute is only required if the template snippet contains the %u or %%DEST_URL%% macro. It has a maximum length of 1024 characters | |
| DestinationUrlType | String | False | No | The action that should be performed if the user clicks on the creative. This attribute is optional and defaults to DestinationUrlType.CLICK_TO_WEB. | |
| HtmlSnippet | String | False | No | The HTML snippet that this creative delivers. | |
| CustomCreativeAssets | String | False | No | A list of file assets that are associated with this creative, and can be referenced in the snippet. | |
| OverrideSize | Bool | True | No | Allows the creative size to differ from the actual HTML5 asset size. This attribute is optional. thirdPartyImpressionTrackingUrls. | |
| IsInterstitial | Bool | False | No | True if this internal redirect creative is interstitial. | |
| PrimaryImageId | Long | True | No | Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates. | |
| PrimaryImageName | String | True | No | The name of the creative. This attribute is required and has a maximum length of 255 characters. | |
| PrimaryImageSize | Long | True | No | Primary image size. | |
| PrimaryImageUrl | String | True | No | Primary image url. | |
| AltText | String | False | No | Alternative text to be rendered along with the creative used mainly for accessibility. This field is optional and has a maximum length of 500 characters. | |
| ThirdPartyImpressionTrackingUrls | String | False | No | A list of impression tracking URL to ping when this creative is displayed. This field is optional and each string has a maximum length of 1024 characters. | |
| AmpRedirectUrl | String | False | No | The URL of the AMP creative. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | Unique ID of the CustomField. This value is readonly and is assigned by Google. | |
| Name | String | False | No | Name of the CustomField. This value is required to create a custom field. The max length is 127 characters. | |
| Description | String | False | No | A description of the custom field. This value is optional. The maximum length is 511 characters. | |
| IsActive | Boolean | True | No | Specifies whether or not the custom field is active. This attribute is read-only. | |
| EntityType | String | False | No | The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field. | |
| DataType | String | False | No | The type of data this custom field contains. This attribute is read-only if a CustomFieldValue exists for this field. | |
| Visibility | String | False | No | How visible/accessible this field is in the UI. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | The ID of the CustomTargetingKey. This value is readonly and is populated by Google. | |
| Name | String | False | No | Name of the key. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. Keys can contain up to 10 characters each. | |
| DisplayName | String | False | No | Descriptive name for the key. | |
| Type | String | False | No | Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item. | |
| Status | String | True | No | Status of the CustomTargetingKey. This field is read-only. A key can be activated and deactivated by calling CustomTargetingService.performCustomTargetingKeyAction. | |
| ReportableType | String | False | No | Reportable state of a {@CustomTargetingKey} as defined in ReportableType. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| CustomTargetingKeyId | Long | False | No | The ID of the CustomTargetingKey for which this is the value. | |
| Id [KEY] | Long | True | No | The ID of the CustomTargetingValue. This value is readonly and is populated by Google. | |
| Name | String | False | No | Name of the value. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. Values can contain up to 40 characters each. | |
| DisplayName | String | False | No | Descriptive name for the value. | |
| MatchType | String | False | No | The way in which the CustomTargetingValue.name strings will be matched. This match type can not be used within an audience segment rule. This match type can not be used within an audience segment rule. This match type can not be used within line item targeting. This match type can not be used within line item targeting. | |
| Status | String | True | No | Status of the CustomTargetingValue. This field is read-only. A value can be activated and deactivated by calling CustomTargetingService.performCustomTargetingValueAction. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| OrderId | String | False | No | The unique ID of the Order. This value is read-only and is assigned by Google. | |
| OrderName | String | False | No | The name of the Order. This value is required to create an Order and has a maximum length of 255 characters. | |
| AdServerImpressions | Long | False | No | The number of impressions delivered by the ad server. Corresponds to 'Ad server impressions' in the Ad Manager UI. Compatible with the 'Historical' report type. | |
| AdServerClicks | Long | False | No | The number of clicks delivered by the ad server. Corresponds to 'Ad server clicks' in the Ad Manager UI. Compatible with the 'Historical' report type. | |
| AdServerCtr | Double | False | No | The CTR for an ad delivered by the ad server. Corresponds to 'Ad server CTR' in the Ad Manager UI. Compatible with the 'Historical' report type. | |
| AdServerCpmAndCpcRevenue | Long | False | No | The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server.Corresponds to 'Ad server CPM and CPC revenue' in the Ad Manager UI. Compatible with the 'Historical' report type. | |
| AdServerWithoutCpdAverageEcpm | Double | False | No | The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server. Corresponds to 'Ad server average eCPM' in the Ad Manager UI. Compatible with the 'Historical' report type. | |
| OrderTrafficker | String | False | No | The name and email address in the form of name (email) of the trafficker for Dimension.ORDER_NAME. Corresponds to 'Trafficker' in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach. | |
| OrderStartDateTime | Datetime | False | No | Represents the start date (in YYYY-MM-DD format) for Dimension.ORDER_NAME. Corresponds to 'Order start date' in the Ad Manager UI. | |
| OrderEndDateTime | Datetime | False | No | Represents the end date (in YYYY-MM-DD format) for Dimension.ORDER_NAME. Corresponds to 'Order end date' in the Ad Manager UI. | |
| EndDate | Date | False | Yes | The end date of the custom date range. The end date cannot be later than today's date. | |
| StartDate | Date | False | Yes | The start date of the custom date range. The start date must be earlier than or the same as the end date. | |
| DateRangeType | String | False | Yes | The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | True | No | Uniquely identifies the AdUnit. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates. | |
| ParentId | String | False | No | 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. This attribute is required when creating the ad unit. Once the ad unit is created, this value will be read-only. | |
| HasChildren | Boolean | True | No | This field is set to true if the ad unit has any children. This attribute is read-only and is populated by Google. | |
| ParentPath | String | True | No | The path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google. | |
| Name | String | False | No | The name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique. | |
| Description | String | False | No | A description of the ad unit. This value is optional and its maximum length is 65,535 characters. | |
| TargetWindow | String | False | No | The value to use for the HTML link's target attribute. This value is optional and will be interpreted as TargetWindow. The default value is TOP. | |
| Status | String | True | No | The status of this ad unit. It defaults to InventoryStatus.ACTIVE. This value cannot be updated directly using InventoryService.updateAdUnit. It can only be modified by performing actions via InventoryService.performAdUnitAction. | |
| AdUnitCode | String | False | No | A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its adUnitCode cannot be changed. | |
| AdUnitSizes | String | False | No | The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the sizes attribute. | |
| IsInterstitial | Boolean | False | No | Whether this is an interstitial ad unit. | |
| IsNative | Boolean | False | No | Whether this is a native ad unit. | |
| IsFluid | Boolean | False | No | Whether this is a fluid ad unit. | |
| ExplicitlyTargeted | Boolean | False | No | If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts. | |
| AdSenseSettings | String | False | No | AdSense specific settings. To overwrite this, set the adSenseSettingsSource to PropertySourceType.DIRECTLY_SPECIFIED when setting the value of this field. | |
| AdSenseSettingsSource | String | False | No | Specifies the source of adSenseSettings value. To revert an overridden value to its default, set this field to PropertySourceType.PARENT. | |
| AppliedLabelFrequencyCaps | String | False | No | The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit. | |
| EffectiveLabelFrequencyCaps | String | True | No | Contains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google. | |
| AppliedLabels | String | True | No | The set of labels applied directly to this ad unit. | |
| EffectiveAppliedLabels | String | True | No | Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. | |
| EffectiveTeamIds | String | True | No | The IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google. | |
| AppliedTeamIds | String | False | No | The IDs of all teams that this ad unit is on directly. | |
| LastModifiedDateTime | Datetime | False | No | The date and time this ad unit was last modified. | |
| SmartSizeMode | String | False | No | The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes. | |
| RefreshRate | Int | False | No | The interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh. | |
| ExternalSetTopBoxChannelId | String | True | No | Specifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if isSetTopBoxEnabled is true. This attribute is read-only. | |
| IsSetTopBoxEnabled | Boolean | True | No | Flag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only. | |
| ApplicationId | Long | False | No | The MobileApplication.applicationId for the CTV application that this ad unit is within. This attribute is optional. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| AdUnitId | String | False | No | This column maps to the field of the same name in the DoubleClick for Publishers API. | |
| AdUnitName | String | False | No | This column maps to the field of the same name in the DoubleClick for Publishers API. | |
| AdServerImpressions | Long | False | No | The number of impressions delivered by the ad server. | |
| AdServerClicks | Long | False | No | The number of clicks delivered by the ad server. | |
| AdExchangeLineItemLevelImpressions | Long | False | No | The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation. | |
| AdExchangeLineItemLevelClicks | Long | False | No | The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation. | |
| TotalLineItemLevelImpressions | Long | False | No | The total number of impressions delivered including line item-level dynamic allocation. | |
| TotalLineItemLevelCPMAndCPCRevenue | Long | False | No | The total CPM and CPC revenue generated by the ad servers including line item-level dynamic allocation. | |
| EndDate | Date | False | Yes | The end date of the custom date range. The end date cannot be later than today's date. | |
| StartDate | Date | False | Yes | The start date of the custom date range. The start date must be earlier than or the same as the end date. | |
| DateRangeType | String | False | Yes | The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | Unique ID of the Label. This value is readonly and is assigned by Google. | |
| Name | String | False | No | Name of the Label. This value is required to create a label and has a maximum length of 127 characters. | |
| Description | String | False | No | A description of the label. This value is optional and its maximum length is 255 characters. | |
| IsActive | Boolean | True | No | Specifies whether or not the label is active. This attribute is read-only. | |
| AdCategory | String | False | No | Indicates the Ad Category associated with the label. | |
| Types | String | False | No | The types of the Label. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| LineItemId | Long | False | No | The ID of the LineItem to which the Creative should be associated. This attribute is required. | |
| CreativeId | Long | False | No | The ID of the Creative object being associated with a LineItem. This attribute is required if this is an association between a line item and a creative. This attribute is ignored if this is an association between a line item and a creative set. If this is an association between a line item and a creative, when retrieving the line item creative association, the creativeId will be the creative's ID. If this is an association between a line item and a creative set, when retrieving the line item creative association, the creativeId will be the ID of the master creative. | |
| CreativeSetId | Long | False | No | The ID of the CreativeSet being associated with a LineItem. This attribute is required if this is an association between a line item and a creative set. This field is null when retrieving associations between line items and creatives not belonging to a set. | |
| ManualCreativeRotationWeight | Double | False | No | The weight of the Creative object. Only use this value if the line item's creativeRotationType is set to CreativeRotationType.MANUAL. This attribute is optional and defaults to 10. | |
| SequentialCreativeRotationIndex | Int | False | No | The sequential rotation index of the Creative. Only use this attribute info the associated line item's LineItem.creativeRotationType is set to CreativeRotationType.SEQUENTIAL. This attribute is optional and defaults to 1. | |
| StartDateTime | Datetime | False | No | Overrides the value set for LineItem.startDateTime. This attribute is optional and is only valid for Ad Manager 360 networks. | |
| StartDateTimeType | String | False | No | Specifies whether to start serving to the LineItemCreativeAssociation right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME. | |
| EndDateTime | Datetime | False | No | Overrides LineItem.endDateTime. Setting this attribute is optional and is only valid for Ad Manager 360 networks. | |
| DestinationUrl | String | False | No | Overrides the value set for HasDestinationUrlCreative.destinationUrl. This attribute is optional and is only valid for Ad Manager 360 networks. | |
| Sizes | String | True | No | Overrides the value set for Creative.size. This attribute contains the aggregated data regarding the size of the creative object. Note that this returns an aggregate XML value. This attribute is optional and read-only. | |
| Stats | String | True | No | Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for the association yet. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this association was last modified. | |
| TargetingName | String | False | No | Specifies CreativeTargeting for this line item creative association. This attribute is optional. It should match the creative targeting specified on the corresponding CreativePlaceholder in the LineItem that is being associated with the Creative. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| OrderId | Long | False | Orders.Id | No | The ID of the Order to which the LineItem belongs. This attribute is required. |
| Id [KEY] | Long | True | No | Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created. | |
| Name | String | False | No | The name of the line item. This attribute is required and has a maximum length of 255 characters. | |
| ExternalId | String | False | No | An identifier for the LineItem that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters. | |
| OrderName | String | True | No | The name of the Order. This value is read-only. | |
| StartDateTime | Datetime | False | No | The date and time on which the LineItem is enabled to begin serving. This attribute is required unless LineItem.StartDateTimeType is set to IMMEDIATELY or ONE_HOUR_FROM_NOW. | |
| StartTimeZoneId | String | False | No | The start date time timezone id of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles). | |
| StartDateTimeType | String | False | No | Specifies whether to start serving to the LineItem right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME. | |
| EndDateTime | Datetime | False | No | The date and time on which the LineItem will stop serving. This attribute is required unless LineItem.unlimitedEndDateTime is set to true. If specified, it must be after the LineItem.startDateTime. This end date and time does not include auto extension days. | |
| EndTimeZoneId | String | False | No | The end date time timezone id of the LineItem. The timezone ID must be in tz database format (e.g. America/Los_Angeles). | |
| AutoExtensionDays | Int | False | No | The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This feature is only available for Ad Manager 360 accounts. | |
| UnlimitedEndDateTime | Bool | False | No | Specifies whether or not the LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE. | |
| CreativeRotationType | String | False | No | The strategy used for displaying multiple Creative objects that are associated with the LineItem. This attribute is required. | |
| DeliveryRateType | String | False | No | The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY or DeliveryRateType.FRONTLOADED depending on the network's configuration. | |
| DeliveryForecastSource | String | False | No | Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to DeliveryForecastSource.HISTORICAL. | |
| CustomPacingCurve | String | False | No | The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is DeliveryForecastSource.CUSTOM_PACING_CURVE. | |
| RoadblockingType | String | False | No | The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to RoadblockingType.ONE_OR_MORE. | |
| SkippableAdType | String | False | No | The nature of the line item's creatives' skippability. This attribute is optional, only applicable for video line items, and defaults to SkippableAdType.NOT_SKIPPABLE. | |
| FrequencyCaps | String | False | No | The set of frequency capping units for this LineItem. This attribute is optional. | |
| LineItemType | String | False | No | Indicates the line item type of a LineItem. This attribute is required. The line item type determines the default priority of the line item. More information can be found on the Ad Manager Help Center. | |
| Priority | Int | False | No | The priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the LineItemType. Each line item type has a default, minimum, and maximum priority value. This field can only be edited by certain networks, otherwise a PermissionError will occur. | |
| CurrencyCode | String | False | No | Three letter currency code in string format. | |
| MicroAmount | Long | False | No | Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros. | |
| ValueCostPerUnit | String | False | No | An amount to help the adserver rank inventory. LineItem.valueCostPerUnit artificially raises the value of inventory over the LineItem.costPerUnit but avoids raising the actual LineItem.costPerUnit. This attribute is optional and defaults to a Money object in the local currency with Money.microAmount 0. | |
| CostType | String | False | No | The method used for billing this LineItem. This attribute is required. | |
| DiscountType | String | False | No | The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType.PERCENTAGE. | |
| Discount | Double | True | No | The number here is either a percentage or an absolute value depending on the LineItemDiscountType. If the LineItemDiscountType is LineItemDiscountType.PERCENTAGE, then only non-fractional values are supported. | |
| ContractedUnitsBought | Long | True | No | This attribute is only applicable for certain line item types and acts as an 'FYI' or note, which does not impact adserving or other backend systems. For LineItemType.SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For LineItemType.STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a 'FYI' for traffickers to manually intervene with the LineItem when needed. This attribute is only available for LineItemType.STANDARD line items if you have this feature enabled on your network. | |
| CreativePlaceholdersAggregate | String | False | No | Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute. | |
| ActivityAssociations | String | False | No | This attribute is required and meaningful only if the LineItem.costType is CostType.CPA. | |
| EnvironmentType | String | False | No | The environment that the LineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER. | |
| AllowedFormats | String | False | No | The set of allowedFormats that this programmatic line item can have. If the set is empty, this line item allows all formats. | |
| CompanionDeliveryOption | String | False | No | The delivery option for companions. Setting this field is only meaningful if the following conditions are met: the Guaranteed roadblocks feature is enabled on your network, and environmentType is EnvironmentType.VIDEO_PLAYER or roadblockingType is RoadblockingType.CREATIVE_SET. This field is optional and defaults to CompanionDeliveryOption.OPTIONAL if the conditions are met. In all other cases it defaults to CompanionDeliveryOption.UNKNOWN and is not meaningful. | |
| AllowOverbook | Bool | False | No | The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType.SPONSORSHIP and LineItemType.STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field will not persist on the line item itself, and the value will only affect the current request. | |
| SkipInventoryCheck | Bool | False | No | The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field will not persist on the line item itself, and the value will only affect the current request. | |
| SkipCrossSellingRuleWarningChecks | Bool | False | No | True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. | |
| ReserveAtCreation | Bool | False | No | The flag indicates whether inventory should be reserved when creating a line item of types LineItemType.SPONSORSHIP and LineItemType.STANDARD in an unapproved Order. The default value is false. | |
| Stats | String | True | No | Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for a line item yet. | |
| DeliveryIndicator | String | True | No | Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons: The line item is not delivering, has an unlimited goal or cap or has a percentage based goal or cap. | |
| DeliveryData | String | True | No | Delivery data provides the number of clicks or impressions delivered for a LineItem in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons: The line item is not deliverable, has completed delivering more than 7 days ago or has an absolute-based goal. | |
| Budget | String | True | No | The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly. | |
| Status | String | True | No | The status of the LineItem. This attribute is readonly. | |
| ReservationStatus | String | True | No | Describes whether or not inventory has been reserved for the LineItem. This attribute is readonly and is assigned by Google. | |
| IsArchived | Bool | True | No | The archival status of the LineItem. This attribute is readonly. | |
| WebPropertyCode | String | False | No | The web property code used for dynamic allocation line items. This web property is only required with line item types LineItemType.AD_EXCHANGE and LineItemType.ADSENSE. | |
| AppliedLabels | String | False | No | The set of labels applied directly to this line item. | |
| EffectiveAppliedLabels | String | True | No | Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. | |
| DisableSameAdvertiserCompetitiveExclusion | Bool | False | No | If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied. | |
| LastModifiedByApp | String | True | No | The application that last modified this line item. This attribute is read only and is assigned by Google. | |
| Notes | String | False | No | Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters. | |
| CompetitiveConstraintScope | String | False | No | The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field is optional, defaults to CompetitiveConstraintScope.POD, and only applies to video line items. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this line item was last modified. | |
| CreationDateTime | Datetime | True | No | This attribute may be null for line items created before this feature was introduced. | |
| IsMissingCreatives | Bool | True | No | Indicates if a LineItem is missing any creatives for the creativePlaceholders specified. Creatives can be considered missing for several reasons including: Not enough creatives of a certain size have been uploaded or The Creative.appliedLabels of an associated Creative do not match the CreativePlaceholder.effectiveAppliedLabels of the LineItem. | |
| ProgrammaticCreativeSource | String | False | No | Indicates the ProgrammaticCreativeSource of the programmatic line item. This is a read-only field. Any changes must be made on the ProposalLineItem. | |
| ThirdPartyMeasurementSettings | String | False | No | ||
| YoutubeKidsRestricted | Bool | False | No | Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the Ad Manager Help Center for more information. | |
| VideoMaxDuration | Long | True | No | The max duration of a video creative associated with this LineItem in milliseconds. This attribute is only meaningful for video line items. For version v202011 and earlier, this attribute is optional and defaults to 0. For version v202102 and later, this attribute is required for video line items and must be greater than 0. | |
| GoalType | String | False | No | The type of the goal for the LineItem. It defines the period over which the goal for LineItem should be reached. | |
| GoalUnitType | String | False | No | The type of the goal unit for the LineItem. | |
| GoalUnits | Int | False | No | If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the LineItem. | |
| SecondaryGoals | String | False | No | The secondary goals that this LineItem is associated with. It is required and meaningful only if the LineItem.costType is CostType.CPA or if the LineItem.lineItemType is LineItemType.SPONSORSHIP and LineItem.costType is CostType.CPM. | |
| GrpSettings | String | False | No | Contains the information for a line item which has a target GRP demographic. | |
| DealInfo | String | False | No | The deal information associated with this line item, if it is programmatic. | |
| ViewabilityProviderCompanyIds | String | False | No | Optional IDs of the Company that provide ad verification for this line item. Company.Type.VIEWABILITY_PROVIDER. | |
| ChildContentEligibility | String | True | No | Child content eligibility designation for this line item. This field is optional and defaults to ChildContentEligibility.DISALLOWED. | |
| CustomVastExtension | String | True | No | Custom XML to be rendered in a custom VAST response at serving time. | |
| GeoTargetingAggregate | String | False | No | Specifies what geographical locations are targeted by the LineItem. This attribute is optional. | |
| InventoryTargetingAggregate | String | False | No | Specifies what inventory is targeted by the LineItem. This attribute is required. The line item must target at least one ad unit or placement. | |
| CustomTargetingAggregate | String | False | No | Specifies the collection of custom criteria that is targeted by the LineItem. | |
| CreativeTargetings | String | False | No | A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a creative placeholder's CreativePlaceholder.targetingName field by referencing the creative targeting's name. It also needs to be re-specified in the LineItemCreativeAssociation.targetingName field when associating a line item with a creative that fits into that placeholder. | |
| CustomFieldName | String | True | No | This is the name of the custom field. There will be as many custom columns as custom fields are related to LineItems. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed. | |
| ApplicationId | Long | True | No | Uniquely identifies the mobile application. This attribute is read-only and is assigned by Google when a mobile application is claimed. The id field is being deprecated in favor of this new ID space. | |
| DisplayName | String | False | No | The display name of the mobile application. This attribute is required and has a maximum length of 255 characters. | |
| AppStoreId | String | False | No | The app store ID of the app to claim. This attribute is required for creation and then is read-only. | |
| AppStores | String | False | No | The app stores the mobile application belongs to. This attribute is required for creation and is mutable to allow for third party app store linking. Possible values include APPLE_ITUNES, GOOGLE_PLAY, ROKU, AMAZON_FIRETV, PLAYSTATION, XBOX, SAMSUNG_TV, AMAZON_APP_STORE, OPPO_APP_STORE, SAMSUNG_APP_STORE, VIVO_APP_STORE, and XIAOMI_APP_STORE. | |
| IsArchived | Boolean | True | No | The archival status of the mobile application. This attribute is read-only. | |
| AppStoreName | String | True | No | The name of the application on the app store. This attribute is read-only and populated by Google. | |
| ApplicationCode | String | True | No | The application code used to identify the app in the SDK. This attribute is read-only and populated by Google. Note that the UI refers to this as 'App ID'. | |
| DeveloperName | String | True | No | The name of the developer of the mobile application. This attribute is read-only and populated by Google. | |
| Platform | String | True | No | The platform the mobile application runs on. This attribute is read-only and populated by Google. | |
| IsFree | Boolean | True | No | Whether the mobile application is free on the app store it belongs to. This attribute is read-only and populated by Google. | |
| DownloadUrl | String | True | No | The download URL of the mobile application on the app store it belongs to. This attribute is read-only and populated by Google. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | False | No | The unique ID of the Order. This value is readonly and is assigned by Google. | |
| Name | String | False | No | The name of the Order. This value is required to create an order and has a maximum length of 255 characters. | |
| StartDateTime | Datetime | True | No | The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItem.startDateTime. | |
| EndDateTime | Datetime | True | No | The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItem.endDateTime. | |
| UnlimitedEndDateTime | Bool | False | No | Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItem.unlimitedEndDateTime set to true. | |
| Status | String | True | No | The status of the Order. This attribute is read-only. | |
| IsArchived | Bool | False | No | The archival status of the Order. This attribute is readonly. | |
| Notes | String | False | No | Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters. | |
| ExternalOrderId | Int | False | Orders.Id | No | An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional. |
| PoNumber | String | False | No | The purchase order number for the Order. This value is optional and has a maximum length of 63 characters. | |
| CurrencyCode | String | True | No | The ISO currency code for the currency used by the Order. This value is read-only and is the network's currency code. | |
| AdvertiserId | Long | False | Companies.Id | No | The unique ID of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. This attribute is required. |
| AdvertiserContactIds | String | False | No | List of IDs for advertiser contacts of the order. | |
| AgencyId | Long | False | Companies.Id | No | The unique ID of the Company, which is of type Company.Type.AGENCY, with which this order is associated. This attribute is optional. |
| AgencyContactIds | String | False | No | List of IDs for agency contacts of the order. | |
| CreatorId | Long | True | Users.Id | No | The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google. |
| TraffickerId | Long | False | Users.Id | No | The unique ID of the User responsible for trafficking the Order. This value is required for creating an order |
| SecondaryTraffickerIds | String | False | No | The IDs of the secondary traffickers associated with the order. This value is optional. | |
| SalespersonId | Long | False | No | The unique ID of the User responsible for the sales of the Order. This value is optional. | |
| SecondarySalespersonIds | String | False | No | The IDs of the secondary salespeople associated with the order. This value is optional. | |
| TotalImpressionsDelivered | Long | True | No | Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. | |
| TotalClicksDelivered | Long | True | No | Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google. | |
| TotalViewableImpressionsDelivered | Long | True | No | Total viewable impressions delivered for all line items of this Order. This value is read-only and is assigned by Google. Starting in v201705, this will be null when the order does not have line items trafficked against a viewable impressions goal. | |
| TotalBudget | String | False | No | Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItem.costPerUnit values. | |
| AppliedLabels | String | False | No | The set of labels applied directly to this order. | |
| EffectiveAppliedLabels | String | True | No | Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. | |
| LastModifiedByApp | String | True | No | The application which modified this order. This attribute is read only and is assigned by Google. | |
| IsProgrammatic | Bool | False | No | Specifies whether or not the Order is a programmatic order. This value is optional and defaults to false. | |
| AppliedTeamIds | String | False | No | The IDs of all teams that this order is on directly. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this order was last modified. | |
| CustomFieldName | String | True | No | This is the name of the custom field. There will be as many custom columns as custom fields are related to Orders. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | Uniquely identifies the Placement. This attribute is read-only and is assigned by Google when a placement is created. | |
| Name | String | False | No | The name of the Placement. This value is required and has a maximum length of 255 characters. | |
| Description | String | False | No | A description of the Placement. This value is optional and its maximum length is 65,535 characters. | |
| PlacementCode | String | True | No | A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created. | |
| Status | String | True | No | The status of the Placement. This attribute is read-only. | |
| TargetedAdUnitIds | String | False | No | The collection of AdUnit object IDs that constitute the Placement. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this placement was last modified. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | The unique ID of the ProposalLineItem. This attribute is read-only. | |
| ProposalId | Long | False | No | The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly. | |
| Name | String | False | No | The name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| StartDateTime | Datetime | False | No | The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime.timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering. | |
| EndDateTime | Datetime | False | No | The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is optional during creation, but required and must be after the startDateTime. The DateTime.timeZoneID is required if end date time is not null. | |
| TimeZoneId | String | False | No | The time zone ID in tz database format (e.g. 'America/Los_Angeles') for this ProposalLineItem. The number of serving days is calculated in this time zone. So if rateType is RateType.CPD, it will affect the cost calculation. The startDateTime and endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone. This attribute is read-only when using programmatic guaranteed, using sales management, or when using programmatic guaranteed, not using sales management. | |
| InternalNotes | String | False | No | Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| IsArchived | Boolean | True | No | The archival status of the ProposalLineItem. This attribute is read-only. | |
| Goal | String | False | No | The goal (i.e. contracted quantity, quantity or limit) that this ProposalLineItem is associated with, which is used in its pacing and budgeting. Goal.units must be greater than 0 when the proposal line item turns into a line item, Goal.goalType and Goal.unitType are readonly. For a Preferred deal ProposalLineItem, the goal type can only be GoalType.NONE. | |
| SecondaryGoals | String | False | No | The secondary goals that this ProposalLineItem is associated with. For a programmatic line item with the properties RateType.CPM and LineItemType.SPONSORSHIP, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list. | |
| ContractedUnitsBought | Long | False | No | The contracted number of impressions or clicks. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is false, then this represents the lifetime minimum impression. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is true, then this represents the daily minimum impression. This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only. | |
| DeliveryRateType | String | False | No | The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is required. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType.FRONTLOADED. | |
| RoadblockingType | String | False | No | The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONE_OR_MORE if not specified by the product. | |
| CompanionDeliveryOption | String | False | No | The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error. | |
| VideoMaxDuration | Long | False | No | The max duration of a video creative associated with this ProposalLineItem in milliseconds. This attribute is optional, defaults to the Product.videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item. | |
| VideoCreativeSkippableAdType | String | False | No | The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType.NOT_SKIPPABLE. | |
| FrequencyCaps | String | False | No | The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false. | |
| DfpLineItemId | Long | True | No | The unique ID of the corresponding LineItem. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only. | |
| LineItemType | String | False | No | The corresponding LineItemType of the ProposalLineItem. For a programmatic ProposalLineItem, the value can only be one of: | |
| LineItemPriority | Int | False | No | The priority for the corresponding LineItem of the ProposalLineItem. This attribute is optional during creation and defaults to the default priority of the lineItemType. For forecasting, this attribute is optional and has a default value assigned by Google. See LineItem.priority for more information. | |
| RateType | String | False | No | The method used for billing the ProposalLineItem. | |
| CreativePlaceholders | String | False | No | Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders. | |
| Targeting | String | False | No | Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting. | |
| AppliedLabels | String | False | No | The set of labels applied directly to the ProposalLineItem. This attribute is optional. | |
| EffectiveAppliedLabels | String | True | No | Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. | |
| DisableSameAdvertiserCompetitiveExclusion | Boolean | False | No | If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied. This attribute is optional and defaults to false. | |
| IsSold | Boolean | True | No | Indicates whether this ProposalLineItem has been sold. This attribute is read-only. | |
| NetRate | String | False | No | The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 100. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required. | |
| NetCost | String | False | No | The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 10000. It doesn't include agency commission. For example, if Proposal.currencyCode is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported. At least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required. | |
| DeliveryIndicator | String | False | No | Indicates how well the line item generated from this proposal line item has been performing. This will be null if the delivery indicator information is not available due to one of the following reasons: | |
| DeliveryData | String | False | No | Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be null if the delivery data cannot be computed due to one of the following reasons: 1) The proposal line item has not pushed to Ad Manager. 2) The line item is not deliverable. 3) The line item has completed delivering more than 7 days ago. 4) The line item has an absolute-based goal. ProposalLineItem.deliveryIndicator should be used to track its progress in this case. | |
| ComputedStatus | String | True | No | The status of the LineItem generated from this proposal line item. This will be null if the proposal line item has not pushed to Ad Manager. This attribute is read-only. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this ProposalLineItem was last modified. This attribute is assigned by Google when a ProposalLineItem is updated. This attribute is read-only. | |
| ReservationStatus | String | True | No | The reservation status of the ProposalLineItem. This attribute is read-only. | |
| LastReservationDateTime | Datetime | True | No | The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only. | |
| EnvironmentType | String | True | No | The environment that the ProposalLineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER. This field is read-only and set to Product.environmentType of the product this proposal line item was created from. | |
| AllowedFormats | String | False | No | The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats. | |
| IsProgrammatic | Boolean | True | No | Whether or not the Proposal for this ProposalLineItem is a programmatic deal. This attribute is populated from Proposal.isProgrammatic. This attribute is read-only. | |
| AdditionalTerms | String | False | No | Additional terms shown to the buyer in Marketplace. | |
| ProgrammaticCreativeSource | String | False | No | Indicates the ProgrammaticCreativeSource of the programmatic line item. | |
| GrpSettings | String | False | No | Contains the information for a proposal line item which has a target GRP demographic. | |
| EstimatedMinimumImpressions | Long | False | No | The estimated minimum impressions that should be delivered for a proposal line item. | |
| ThirdPartyMeasurementSettings | String | False | No | Contains third party measurement settings for cross-sell Partners. | |
| MakegoodInfo | String | False | No | Makegood info for this proposal line item. Immutable once created. Null if this proposal line item is not a makegood. | |
| HasMakegood | Boolean | True | No | Whether this proposal line item has an associated makegood. This attribute is read-only. | |
| CanCreateMakegood | Boolean | True | No | Whether a new makegood associated with this line item can be created. This attribute is read-only. | |
| PauseRole | String | True | No | The NegotiationRole that paused the proposal line item, i.e. NegotiationRole.seller or NegotiationRole.buyer, or null when the proposal is not paused. This attribute is read-only. | |
| PauseReason | String | True | No | The reason for pausing the ProposalLineItem, provided by the pauseRole. It is null when the ProposalLineItem is not paused. This attribute is read-only. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | The unique ID of the Proposal. This attribute is read-only. | |
| IsProgrammatic | Boolean | False | No | Flag that specifies whether this Proposal is for programmatic deals. This value is default to false. | |
| DfpOrderId | Long | True | No | The unique ID of the corresponding Order. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only. | |
| Name | String | False | No | The name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.name when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| StartDateTime | Datetime | True | No | The date and time at which the order and line items associated with the Proposal are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest ProposalLineItem.startDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only. | |
| EndDateTime | Datetime | True | No | The date and time at which the order and line items associated with the Proposal stop being served. This attribute is derived from the proposal line item of the proposal which has the latest ProposalLineItem.endDateTime. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only. | |
| Status | String | True | No | The status of the Proposal. This attribute is read-only. | |
| IsArchived | Boolean | True | No | The archival status of the Proposal. This attribute is read-only. | |
| Advertiser | String | False | No | The advertiser, to which this Proposal belongs, and a set of Contact objects associated with the advertiser. The ProposalCompanyAssociation.type of this attribute should be ProposalCompanyAssociationType.ADVERTISER. This attribute is required when the proposal turns into an order, and its ProposalCompanyAssociation.companyId will be copied to Order.advertiserId. This attribute becomes readonly once the Proposal has been pushed. | |
| Agencies | String | False | No | List of agencies and the set of Contact objects associated with each agency. This attribute is optional. A Proposal only has at most one Company with ProposalCompanyAssociationType.PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If primary agency exists, its ProposalCompanyAssociation.companyId will be copied to Order.agencyId when the proposal turns into an order. | |
| InternalNotes | String | False | No | Provides any additional notes that may annotate the Proposal. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| PrimarySalesperson | String | False | No | The primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| SalesPlannerIds | Long | False | No | List of unique IDs of the User objects who are the sales planners of the Proposal. This attribute is optional. A proposal can have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| PrimaryTraffickerId | Long | False | No | The unique ID of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.primaryTraffickerId . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| SellerContactIds | Long | False | No | Users who are the seller's contacts. | |
| AppliedTeamIds | Long | False | No | The IDs of all teams that the Proposal is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. | |
| AppliedLabels | String | False | No | The set of labels applied directly to the Proposal. This attribute is optional. | |
| EffectiveAppliedLabels | String | True | No | Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. | |
| CurrencyCode | String | False | No | The currency code of this Proposal. This attribute is optional and defaults to network's currency code. | |
| IsSold | Boolean | True | No | Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is OrderStatus.APPROVED or OrderStatus.PAUSED. This attribute is read-only. | |
| LastModifiedDateTime | Datetime | True | No | The date and time this Proposal was last modified. This attribute is read-only. | |
| MarketplaceInfo | String | False | No | The marketplace info of this proposal if it has a corresponding order in Marketplace. | |
| BuyerRfp | String | False | No | The buyer RFP associated with this Proposal, which is optional. This field will be null if the proposal is not initiated from RFP. | |
| HasBuyerRfp | Boolean | False | No | Whether a Proposal contains a BuyerRfp field. If this field is true, it indicates that the Proposal in question orignated from a buyer. | |
| DeliveryPausingEnabled | Boolean | False | No | Whether pausing is consented for the Proposal. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | The unique ID of the role. This value is readonly and is assigned by Google. Roles that are created by Google will have negative IDs. | |
| Name | String | True | No | The name of the role. This value is readonly and is assigned by Google. | |
| Description | String | True | No | The description of the role. This value is readonly and is assigned by Google. | |
| Status | String | True | No | The status of the Role. This field is read-only and can have the values RoleStatus.ACTIVE (default) or RoleStatus.INACTIVE, which determines the visibility of the role in the UI. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| SalesPersonId | String | False | No | Breaks down reporting data by salesperson User.id. | |
| SalesPersonName | String | False | No | Breaks down reporting data by salesperson. | |
| AdServerImpressions | Long | False | No | The number of impressions delivered by the ad server. | |
| AdServerCpmAndCpcRevenue | Long | False | No | The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server. | |
| AdServerWithoutCpdAverageEcpm | Long | False | No | The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server. | |
| EndDate | Date | False | Yes | The end date of the custom date range. The end date cannot be later than today's date. | |
| StartDate | Date | False | Yes | The start date of the custom date range. The start date must be earlier than or the same as the end date. | |
| DateRangeType | String | False | Yes | The period of time for which the reporting data is being generated. Supported values are: TODAY, YESTERDAY, LAST_WEEK, LAST_MONTH, LAST_3_MONTHS, REACH_LIFETIME, CUSTOM_DATE, NEXT_DAY, NEXT_90_DAYS, NEXT_WEEK, NEXT_MONTH, CURRENT_AND_NEXT_MONTH, NEXT_QUARTER, NEXT_3_MONTHS, NEXT_12_MONTHS. In order to define custom time periods, set this to CUSTOM_DATE. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | Long | True | No | The unique ID of the User. This attribute is readonly and is assigned by Google. | |
| Name | String | False | No | The name of the User. It has a maximum length of 128 characters. | |
| String | False | No | The email or login of the User. In order to create a new user, you must already have a Google Account. | ||
| RoleId | Long | False | Roles.Id | No | The unique role ID of the User. Roles that are created by Google will have negative IDs. |
| RoleName | String | True | No | The name of the role assigned to the User. This attribute is readonly. | |
| IsActive | Boolean | True | No | Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only. | |
| IsEmailNotificationAllowed | Boolean | False | No | Specifies whether or not the User wants to permit the Publisher Display Ads system to send email notifications to their email address. This attribute is optional and defaults to true. | |
| ExternalId | String | False | No | An identifier for the User that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters. | |
| IsServiceAccount | Boolean | True | No | Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI. | |
| OrdersUiLocalTimeZoneId | String | False | No | The long format timezone id (e.g. 'America/Los_Angeles') used in the orders and line items UI for this User. Set this to null to indicate that no such value is defined for the User - UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses. |