広告申込情報を有効にする

Display & Video 360 API を使用して作成された広告申込情報は、最初はすべて下書きの状態になります。この下書きの状態では、広告申込情報は広告を配信しないため、設定とターゲティングを自由に調整できます。変更が現在の広告配信に影響することはありません。このページでは、広告配信の準備が整っているかどうかを確認する手順と、ステータスを有効に更新する方法について説明します。

有効化する前の準備

広告申込情報は、広告の購入と配信を通じて広告収入が支出される仕組みであるため、有効にしたときに広告申込情報が意図したとおりに広告を配信するようにすることが重要です。広告申込情報の有効化前に考慮すべき点は次のとおりです。

• 配信設定が正しいことを確認する: 広告申込情報の flight フィールドで、広告申込情報の配信期間が正しく設定されていることを確認します。広告申込情報のフライト期間は、広告申込情報にカスタマイズすることも、親広告掲載オーダーから継承することもできます。
• 広告申込情報の配信を妨げる警告がないことを確認します。advertisers.lineItems.get を使用して広告申込情報リソースを取得し、フィールド warningMessages をチェックして、広告申込情報の配信を妨げる可能性がある警告がないことを確認します。LineItemWarningMessage 列挙型には、各警告の影響が示されます。
• すべての親リソースが有効になっていることを確認する: 有効な広告申込情報でも、その親である広告主、キャンペーン、広告掲載オーダーが有効でない場合、広告の配信は開始されません。これらのリソースを取得するには、Advertisers、Campaigns、Insertion Orders サービスの GET メソッドを使用します。

広告申込情報を有効にする

広告申込情報を有効にするには、entityStatus フィールドを ENTITY_STATUS_ACTIVE に更新します。個々の広告申込情報のこのフィールドは advertisers.lineItems.patch メソッドで更新できます。特定の広告主内の複数の広告申込情報のこのフィールドは advertisers.lineItems.bulkUpdate で更新できます。

警告: 同じ広告申込情報またはそのターゲティングを更新する他のリクエストと同時に、patch リクエストまたは bulkUpdate リクエストを実行しないでください。

bulkUpdate を使用して複数の広告申込情報の有効化を行う方法の例を次に示します。

Java

// Create the line item structure.
LineItem targetLineItem = new LineItem();
targetLineItem.setEntityStatus("ENTITY_STATUS_ACTIVE");

// Create the bulk update request body.
BulkUpdateLineItemsRequest requestBody = new BulkUpdateLineItemsRequest();
requestBody.setLineItemIds(line-item-ids);
requestBody.setTargetLineItem(targetLineItem);
requestBody.setUpdateMask("entityStatus");

// Configure the bulk update request.
LineItems.BulkUpdate request = service.advertisers().lineItems()
    .bulkUpdate(advertiser-id, requestBody);

// Update the line items.
BulkUpdateLineItemsResponse response = request.execute();

// Display the line items that were updated, failed, and skipped.
if (response.getUpdatedLineItemIds() != null) {
  System.out.printf(
      "The following line item IDs were successfully updated: %s.\n",
      Arrays.toString(response.getUpdatedLineItemIds().toArray()));
}
if (response.getFailedLineItemIds() != null) {
  System.out.printf("The following line item IDs failed to update: %s.\n",
      Arrays.toString(response.getFailedLineItemIds().toArray()));
  if (response.getErrors() != null) {
    System.out.printf(
        "The failed updates were caused by the following errors: %s.\n",
        Arrays.toString(response.getErrors().toArray()));
  }
}
if (response.getSkippedLineItemIds() != null) {
  System.out.printf(
      "The following line items IDs were skipped in the update: %s.\n",
      Arrays.toString(response.getSkippedLineItemIds().toArray()));
}

Python

# Create a line item object with only updated entity status.
line_item_obj = {
    'entityStatus': 'ENTITY_STATUS_ACTIVE'
}

# Build the bulk update request.
bulk_update_request = {
    'lineItemIds': line-item-ids,
    'targetLineItem': line_item_obj,
    'updateMask': "entityStatus"
}

# Update the line items.
response = service.advertisers().lineItems().bulkUpdate(
    advertiserId=advertiser-id,
    body=bulk_update_request
).execute()

# Display the line items that were updated, failed, and skipped.
if 'updatedLineItemIds' in response:
  print("The following line item IDs were updated: %s"
        % response['updatedLineItemIds'])
if 'failedLineItemIds' in response:
  print("The following line item IDs failed to update: %s"
        % response['failedLineItemIds'])
  if 'errors' in response:
    print("The failed updates were caused by the following errors:")
    for error in response["errors"]:
      print("Error code: %s, Message: %s" % (error["code"], error["message"]))
if 'skippedLineItemIds' in response:
  print("The following line items IDs were skipped in the update:: %s"
        % response['skippedLineItemIds'])

PHP

// Create request body.
$body = new Google_Service_DisplayVideo_BulkUpdateLineItemsRequest();
$body->setLineItemIds(line-item-ids);

// Create target line item with updated fields.
$lineItem = new Google_Service_DisplayVideo_LineItem();
$lineItem->setEntityStatus('ENTITY_STATUS_ACTIVE');
$body->setTargetLineItem($lineItem);

// Set update mask in request body.
$body->setUpdateMask("entityStatus");

// Call the API, updating the entity status for the identified line item.
$response = $service->advertisers_lineItems->bulkUpdate(
    advertiser-id,
    $body
);

// Display the line items that were updated, failed, and skipped.
if (!empty($response->getUpdatedLineItemIds())) {
    printf('The following line item IDs were updated:\n');
    foreach ($response->getUpdatedLineItemIds() as $id) {
        printf('%s\n', $id);
    }
}
if (!empty($response->getFailedLineItemIds())) {
    print('The following line item IDs failed to update:\n');
    foreach ($response->getFailedLineItemIds() as $id) {
        printf('%s\n', $id);
    }
    if (!empty($response->getErrors())) {
        print('The failed updates were caused by the following errors:\n');
        foreach ($response->getErrors() as $error) {
            printf(
                'Error Code: %s, Message: %s\n',
                $error->getCode(),
                $error->getMessage()
            );
        }
    }
}
if (!empty($response->getSkippedLineItemIds())) {
    print('The following line item IDs were skipped in the update:\n');
    foreach ($response->getSkippedLineItemIds() as $id) {
        printf('%s\n', $id);
    }
}