Display & Video 360 API . inventorySourceGroups

close()

Close httplib2 connections.

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

Creates a new inventory source group. Returns the newly created inventory source group if successful.

Args:
  body: object, The request body.
    The object takes the form of:

{ # A collection of targetable inventory sources.
  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
  "name": "A String", # Output only. The resource name of the inventory source group.
}

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

Returns:
  An object of the form:

    { # A collection of targetable inventory sources.
  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
  "name": "A String", # Output only. The resource name of the inventory source group.
}

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

Deletes an inventory source group.

Args:
  inventorySourceGroupId: string, Required. The ID of the inventory source group to delete. (required)
  advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
  partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
  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); }
}

get(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)

Gets an inventory source group.

Args:
  inventorySourceGroupId: string, Required. The ID of the inventory source group to fetch. (required)
  advertiserId: string, The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
  partnerId: string, The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A collection of targetable inventory sources.
  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
  "name": "A String", # Output only. The resource name of the inventory source group.
}

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

Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.

Args:
  advertiserId: string, The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
  filter: string, Allows filtering by inventory source group 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` 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) * `inventorySourceGroupId` 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 group. A partner cannot access advertiser-owned inventory source groups.
  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 InventorySourceGroupService.ListInventorySourceGroups.
  "inventorySourceGroups": [ # The list of inventory source groups. This list will be absent if empty.
    { # A collection of targetable inventory sources.
      "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
      "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
      "name": "A String", # Output only. The resource name of the inventory source group.
    },
  ],
  "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 `ListInventorySourceGroups` 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(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)

Updates an inventory source group. Returns the updated inventory source group if successful.

Args:
  inventorySourceGroupId: string, Output only. The unique ID of the inventory source group. Assigned by the system. (required)
  body: object, The request body.
    The object takes the form of:

{ # A collection of targetable inventory sources.
  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
  "name": "A String", # Output only. The resource name of the inventory source group.
}

  advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
  partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
  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:

    { # A collection of targetable inventory sources.
  "displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
  "inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
  "name": "A String", # Output only. The resource name of the inventory source group.
}