Display & Video 360 API . inventorySourceGroups . assignedInventorySources

bulkEdit(inventorySourceGroupId, body=None, x__xgafv=None)

Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.

Args:
  inventorySourceGroupId: string, Required. The ID of the inventory source group to which the assignments are assigned. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for AssignedInventorySourceService.BulkEdit.
  "advertiserId": "A String", # The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.
  "createdAssignedInventorySources": [ # The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources.
    { # An assignment between a targetable inventory source and an inventory source group.
      "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
      "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
      "name": "A String", # Output only. The resource name of the assigned inventory source.
    },
  ],
  "deletedAssignedInventorySources": [ # The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids.
    "A String",
  ],
  "partnerId": "A String", # The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AssignedInventorySourceService.BulkEdit.
  "assignedInventorySources": [ # The list of assigned inventory sources that have been successfully created. This list will be absent if empty.
    { # An assignment between a targetable inventory source and an inventory source group.
      "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
      "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
      "name": "A String", # Output only. The resource name of the assigned inventory source.
    },
  ],
}

close()

Close httplib2 connections.

create(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)

Creates an assignment between an inventory source and an inventory source group.

Args:
  inventorySourceGroupId: string, Required. The ID of the inventory source group to which the assignment will be assigned. (required)
  body: object, The request body.
    The object takes the form of:

{ # An assignment between a targetable inventory source and an inventory source group.
  "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
  "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
  "name": "A String", # Output only. The resource name of the assigned inventory source.
}

  advertiserId: string, The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
  partnerId: string, The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An assignment between a targetable inventory source and an inventory source group.
  "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
  "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
  "name": "A String", # Output only. The resource name of the assigned inventory source.
}

delete(inventorySourceGroupId, assignedInventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)

Deletes the assignment between an inventory source and an inventory source group.

Args:
  inventorySourceGroupId: string, Required. The ID of the inventory source group to which this assignment is assigned. (required)
  assignedInventorySourceId: string, Required. The ID of the assigned inventory source to delete. (required)
  advertiserId: string, The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
  partnerId: string, The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}

list(inventorySourceGroupId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

Lists inventory sources assigned to an inventory source group.

Args:
  inventorySourceGroupId: string, Required. The ID of the inventory source group to which these assignments are assigned. (required)
  advertiserId: string, The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.
  filter: string, Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedInventorySourceId` The length of this field should be no more than 500 characters.
  orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`.
  pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
  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 `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
  partnerId: string, The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AssignedInventorySourceService.ListAssignedInventorySources.
  "assignedInventorySources": [ # The list of assigned inventory sources. This list will be absent if empty.
    { # An assignment between a targetable inventory source and an inventory source group.
      "assignedInventorySourceId": "A String", # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
      "inventorySourceId": "A String", # Required. The ID of the inventory source entity being targeted.
      "name": "A String", # Output only. The resource name of the assigned inventory source.
    },
  ],
  "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 `ListAssignedInventorySources` method to retrieve the next page of results.
}

list_next(previous_request, previous_response)

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.