REST Resource: partners

  • Display & Video 360 API v3 has been sunset and users should transition to v4.

  • The Partner resource in the v3 API represents a single partner in Display & Video 360 with associated configuration objects for general, ad server, data access, exchange, and billing settings.

  • The Partner resource and its related configuration objects are defined with specific fields, data types, and JSON representations.

  • The v3 Partner resource includes methods for editing targeting options, getting a single partner, and listing partners.

Resource: Partner

A single partner in Display & Video 360 (DV360).

JSON representation 
{
  "name": string,
  "partnerId": string,
  "updateTime": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "generalConfig": {
    object (PartnerGeneralConfig)
  },
  "adServerConfig": {
    object (PartnerAdServerConfig)
  },
  "dataAccessConfig": {
    object (PartnerDataAccessConfig)
  },
  "exchangeConfig": {
    object (ExchangeConfig)
  },
  "billingConfig": {
    object (PartnerBillingConfig)
  }
}
Fields
name

string

Output only. The resource name of the partner.
partnerId

string (int64 format)

Output only. The unique ID of the partner. Assigned by the system.
updateTime

string (Timestamp format)

Output only. The timestamp when the partner was last updated. Assigned by the system.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
displayName

string

The display name of the partner.

Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus

enum (EntityStatus)

Output only. The status of the partner.
generalConfig

object (PartnerGeneralConfig)

General settings of the partner.
adServerConfig

object (PartnerAdServerConfig)

Ad server related settings of the partner.
dataAccessConfig

object (PartnerDataAccessConfig)

Settings that control how partner data may be accessed.
exchangeConfig

object (ExchangeConfig)

Settings that control which exchanges are enabled for the partner.
billingConfig

object (PartnerBillingConfig)

Billing related settings of the partner.

PartnerGeneralConfig

General settings of a partner.

JSON representation 
{
  "timeZone": string,
  "currencyCode": string
}
Fields
timeZone

string

Immutable. The standard TZ database name of the partner's time zone. For example, America/New_York.

See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
currencyCode

string

Immutable. Partner's currency in ISO 4217 format.

PartnerAdServerConfig

Ad server related settings of a partner.

JSON representation 
{
  "measurementConfig": {
    object (MeasurementConfig)
  }
}
Fields
measurementConfig

object (MeasurementConfig)

Measurement settings of a partner.

MeasurementConfig

Measurement settings of a partner.

JSON representation 
{
  "dv360ToCmCostReportingEnabled": boolean,
  "dv360ToCmDataSharingEnabled": boolean
}
Fields
dv360ToCmCostReportingEnabled

boolean

Whether or not to report DV360 cost to CM360.
dv360ToCmDataSharingEnabled

boolean

Whether or not to include DV360 data in CM360 data transfer reports.

PartnerDataAccessConfig

Settings that control how partner related data may be accessed.

JSON representation 
{
  "sdfConfig": {
    object (SdfConfig)
  }
}
Fields
sdfConfig

object (SdfConfig)

Structured Data Files (SDF) settings for the partner.

The SDF configuration for the partner.

ExchangeConfig

Settings that control which exchanges are enabled for a partner.

JSON representation 
{
  "enabledExchanges": [
    {
      object (EnabledExchange)
    }
  ]
}
Fields
enabledExchanges[]

object (EnabledExchange)

All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.

EnabledExchange

An enabled exchange in the partner.

JSON representation 
{
  "exchange": enum (Exchange),
  "googleAdManagerAgencyId": string,
  "googleAdManagerBuyerNetworkId": string,
  "seatId": string
}
Fields
exchange

enum (Exchange)

The enabled exchange.
googleAdManagerAgencyId

string

Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.
googleAdManagerBuyerNetworkId

string

Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.
seatId

string

Output only. Seat ID of the enabled exchange.

PartnerBillingConfig

Billing related settings of a partner.

JSON representation 
{
  "billingProfileId": string
}
Fields
billingProfileId

string (int64 format)

The ID of a partner default billing profile.

Methods

editAssignedTargetingOptions

 Edits targeting options under a single partner.

get

 Gets a partner.

list

 Lists partners that are accessible to the current user.