Audit Account Limits

There are limits as to the number of entities that can be active under certain Display & Video 360 resources. These account limits are relatively generous and rarely reached, but you can proactively avoid reaching them by taking the steps outlined in this guide.

This page discusses how to get and optimize entity counts using the Display & Video 360 API.

Audit an advertiser

The total count of used entities contributing to account limits for a resource can be retrieved through advertisers.audit. These entity counts include types not retrievable or editable through the API, such as YouTube & partners Line Items.

The following code is an example of how to audit and display your current counts for a given advertiser:

Java

// Create read mask to restrict audit results to
// the relevant account limits.
String auditMask = "usedInsertionOrdersCount,usedLineItemsCount";

// Configure the audit request.
Advertisers.Audit request =
    service.advertisers().audit(advertiser-id);

// Set the read mask for the request.
request.setReadMask(auditMask);

// Execute the request.
AuditAdvertiserResponse response = request.execute();

// Print resulting advertiser used entity counts.
System.out.println("Advertiser Audit:");

if (response.getUsedInsertionOrdersCount() != null) {
  System.out.printf("Used Insertion Orders: %s of 9999 \n",
      response.getUsedInsertionOrdersCount());
} else {
  System.out.println("Used Insertion Orders: 0 of 9999");
}

if (response.getUsedLineItemsCount() != null) {
  System.out.printf("Used Line Items: %s of 9999 \n",
      response.getUsedLineItemsCount());
} else {
  System.out.println("Used Line Items: 0 of 9999");
}

Python

# Create read mask to restrict audit results to
# the relevant account limits.
audit_mask = 'usedInsertionOrdersCount,usedLineItemsCount'

# Build and execute request.
response = service.advertisers().audit(
    advertiserId=advertiser-id,
    readMask=audit_mask
).execute()

# Print resulting advertiser used entity counts.
print('Advertiser audit:')

if 'usedInsertionOrdersCount' in response:
  print('Used Insertion Orders: %s of 9999' %
        response['usedInsertionOrdersCount'])
else:
  print('Used Insertion Orders: 0 of 9999')

if 'usedLineItemsCount' in response:
  print('Used Line Items: %s of 9999' % response['usedLineItemsCount'])
else:
  print('Used Line Items: 0 of 9999')

Optimize entity counts

To ensure that account limits are not reached, delete or archive resources when they're no longer needed.

Archive finished line items

If an advertiser audit shows that the number of used line items under your advertiser is nearing the set limit, archive existing line items that have finished serving ads in order to allow yourself to continue making new line items.

These line items can be found by utilizing the filter field of advertisers.lineItems.list and archived using advertisers.lineItems.patch.

Java

// Create the empty line items list.
ArrayList<Long> oldLineItems = new ArrayList<Long>();

// Create the filter string with the desired date.
// The filter date must be in the format YYYY-MM-DD.
String dateFilter =
    "flight.dateRange.endDate<".concat(filter-date);

// Configure the list request.
LineItems.List listRequest =
    service.advertisers().lineItems().list(advertiser-id);

// Set the filter for the request
listRequest.setFilter(dateFilter);

// Create the response and nextPageToken variables.
ListLineItemsResponse listResponse;
String nextPageToken = null;

do {
  // Create and execute the list request.
  listResponse = listRequest.setPageToken(nextPageToken).execute();

  // Check if response is empty.
  if (listResponse.isEmpty()) {
    System.out.print("List request returned no Line Items");
    break;
  }

  // Iterate over retrieved line items and add to total list.
  for (LineItem lineItem : listResponse.getLineItems()) {
    oldLineItems.add(lineItem.getLineItemId());
  }

  // Update the next page token.
  nextPageToken = listResponse.getNextPageToken();
} while (!Strings.isNullOrEmpty(nextPageToken));

// Create the line item structure.
LineItem lineItem = new LineItem();
lineItem.setEntityStatus("ENTITY_STATUS_ARCHIVED");

for (Long lineItemId : oldLineItems) {
  // Build the patch request.
  LineItems.Patch patchRequest = service.advertisers().lineItems()
      .patch(advertiser-id, lineItemId, lineItem);

  // Set update mask to only update entity status.
  patchRequest.setUpdateMask("entityStatus");

  // Execute the request.
  LineItem patchResponse = patchRequest.execute();

  // Display the updated entity status of the line item.
  System.out.printf("LineItem %s now has entity status %s",
      patchResponse.getName(),
      patchResponse.getEntityStatus());
}

Python

# Create the empty line items list.
old_line_items = []

# Create the filter string with the desired date.
# The filter date must be in the format YYYY-MM-DD.
date_filter = 'flight.dateRange.endDate<%s' % filter-date

# Create the page token variable.
next_page_token = ''

while True:
  # Request line item list.
  response = service.advertisers().lineItems().list(
      advertiserId=advertiser-id,
      filter=date_filter,
      fields='lineItems(lineItemId),nextPageToken',
      pageToken=next_page_token
  ).execute()

  # Check if the response is empty.
  if not response:
    print('List request returned no line items')
    return

  for item in response['lineItems']:
    old_line_items.append(item['lineItemId'])

  # Break out of the loop if there is no next page.
  if 'nextPageToken' not in response:
    break

  next_page_token = response['nextPageToken']

# Create the general line item update object.
line_item_obj = {
   'entityStatus': 'ENTITY_STATUS_ARCHIVED',
}

# Archive each old line item by updating the entity status
for id in old_line_items:
  # Build and execute the request.
  response = service.advertisers().lineItems().patch(
      advertiserId=advertiser-id,
      lineItemId=id,
      updateMask='entityStatus',
      body=line_item_obj,
      fields='name,entityStatus'
  ).execute()

  print('Line Item %s now has entity status %s.'
        % (response['name'], response['entityStatus']))