Close httplib2 connections.
create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)
Creates a new inventory source. Returns the newly created inventory source if successful.
editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
get(inventorySourceId, partnerId=None, x__xgafv=None)
Gets an inventory source.
Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Retrieves the next page of results.
Updates an existing inventory source. Returns the updated inventory source if successful.
close()
Close httplib2 connections.
create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)
Creates a new inventory source. Returns the newly created inventory source if successful.
Args:
body: object, The request body.
The object takes the form of:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}
advertiserId: string, The ID of the advertiser that the request is being made within.
partnerId: string, The ID of the partner that the request is being made within.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}
editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Args:
inventorySourceId: string, Required. The ID of inventory source to update. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.
"advertisersUpdate": { # Update to the list of advertisers with read/write access to the inventory source. # The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor.
"addedAdvertisers": [ # The advertisers to add.
"A String",
],
"removedAdvertisers": [ # The advertisers to remove.
"A String",
],
},
"assignPartner": True or False, # Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.
"partnerId": "A String", # Required. The partner context by which the accessors change is being made.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The partner or advertisers with access to the inventory source.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
}
get(inventorySourceId, partnerId=None, x__xgafv=None)
Gets an inventory source.
Args:
inventorySourceId: string, Required. The ID of the inventory source to fetch. (required)
partnerId: string, Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}
list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)
Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Args:
advertiserId: string, The ID of the advertiser that has access to the inventory source.
filter: string, Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.
partnerId: string, The ID of the partner that has access to the inventory source.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"inventorySources": [ # The list of inventory sources. This list will be absent if empty.
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)
Updates an existing inventory source. Returns the updated inventory source if successful.
Args:
inventorySourceId: string, Output only. The unique ID of the inventory source. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}
advertiserId: string, The ID of the advertiser that the request is being made within.
partnerId: string, The ID of the partner that the request is being made within.
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}