このページは Cloud Translation API によって翻訳されました。

レポートを作成、更新する

Campaign Manager 360 API の Reports サービスでは、レポートリソースオブジェクトを使用してレポートビルダーレポートを作成および更新できます。レポートリソースは、実行するレポートの基本情報とレポート出力の構造を示します。

このガイドでは、Reports サービスを使用してレポートビルダーレポートをプログラマティックに作成、更新する方法について詳しく説明します。

レポートリソースを構成する

レポートビルダーレポートを作成または更新するための最初のステップは、レポートリソースオブジェクトを設定することです。新しいレポートを作成する場合は、まず空のリソースから必要なフィールドを設定します。既存のレポートを更新する場合は、次のいずれかを選択できます。

推奨: 部分更新を行います。この方法では、空のリソースから始めて、変更するフィールドを設定します。部分更新では、指定したフィールドの変更のみが保存されます。
フルアップデートの実行。この方法では、既存のレポートリソースを読み込み、そのフィールドを直接変更します。全体を更新すると、常にレポートのすべてのフィールドが保存されます。

レポートリソースの正確な内容は、設定するレポートの種類によって異なります。ただし、以下のフィールドはすべてのレポートタイプに共通です。

フィールド	説明
必須フィールド
name	レポートの名前。
type	レポートのタイプ。
省略可能項目
delivery	レポートのメール配信設定。
fileName	このレポートのレポートファイルの生成時に使用するファイル名。
形式	レポートの出力形式（CSV または Excel）。
スケジュール	レポートを定期的に作成するためのスケジュールです。

これらの共通フィールドがレポートのスケルトンを構成します。下の例は、新しい標準レポートリソースの作成方法を示しています。

C#

Report report = new Report();

// Set the required fields "name" and "type".
report.Name = "Example standard report";
report.Type = "STANDARD";

// Set optional fields.
report.FileName = "example_report";
report.Format = "CSV";

Java

Report report = new Report();

// Set the required fields "name" and "type".
report.setName("Example standard report");
report.setType("STANDARD");

// Set optional fields
report.setFileName("example_report");
report.setFormat("CSV");

PHP

$report = new Google_Service_Dfareporting_Report();

// Set the required fields "name" and "type".
$report->setName('Example standard report');
$report->setType('STANDARD');

// Set optional fields.
$report->setFileName('example_report');
$report->setFormat('CSV');

Python

report = {
    # Set the required fields "name" and "type".
    'name': 'Example Standard Report',
    'type': 'STANDARD',
    # Set optional fields.
    'fileName': 'example_report',
    'format': 'CSV'
}

Ruby

report = DfareportingUtils::API_NAMESPACE::Report.new(
  # Set the required fields "name" and "type".
  name: 'Example Standard Report',
  type: 'STANDARD',
  # Set optional fields.
  file_name: 'example_report',
  format: 'CSV'
)

レポートの条件を定義する

レポートタイプを選択して共通フィールドを設定したら、次にレポートの条件を定義します。レポートの条件を使用してレポートの範囲を限定し、関連情報のみが返されるようにします。また、レポート出力の構造も定義します。

使用される条件は、レポートの種類によって異なります。レポートの種類と条件の関係を次の表に示します。

レポートの種類	条件フィールド
標準	条件
REACH	reachCriteria
PATH_TO_CONVERSION	pathToConversionCriteria
Floodlight	floodlightCriteria
CROSS_DIMENSION_REACH	crossDimensionReachCriteria

タイプ固有の条件によってそれぞれ表示されるフィールドは若干異なりますが、一般的に、レポート出力の制御に役立つ共通の基準フィールドのセットがあります。

フィールド	説明
dateRange	このレポートの実行期間。カスタムの開始日と終了日、または相対的な期間を指定できます。注: API を使用してレポートを実行する場合、`YESTERDAY` などの相対的な期間はアメリカ/ロサンゼルスのタイムゾーンで解決されます。これにより、異なるタイムゾーンのユーザーに予期しない結果が生じる可能性があります。
dimensionFilters	返される結果を制限するフィルタのリスト。フィルタの構成の詳細については、フィルタ値をクエリするセクションをご覧ください。
寸法	レポート出力に含めるキャンペーンマネージャー 360 の要素のリスト。
metricNames	レポート出力に含める標準の計量単位。

レポートのディメンション、指標、フィルタの選択について詳しくは、フィールドの互換性を判断するのセクションをご覧ください。タイプ固有のその他の条件フィールドについては、リファレンスドキュメントとヘルプセンターをご覧ください。

以下の例では、標準レポートリソースに基本的な条件を追加しています。

C#

// Define a date range to report on. This example uses explicit start and
// end dates to mimic the "LAST_30_DAYS" relative date range.
DateRange dateRange = new DateRange();
dateRange.EndDate = DateTime.Now.ToString("yyyy-MM-dd");
dateRange.StartDate = DateTime.Now.AddDays(-30).ToString("yyyy-MM-dd");

// Create a report criteria.
SortedDimension dimension = new SortedDimension();
dimension.Name = "advertiser";

Report.CriteriaData criteria = new Report.CriteriaData();
criteria.DateRange = dateRange;
criteria.Dimensions = new List<SortedDimension>() { dimension };
criteria.MetricNames = new List<string>() {
  "clicks",
  "impressions"
};

// Add the criteria to the report resource.
report.Criteria = criteria;

Java

// Define a date range to report on. This example uses explicit start and end dates to mimic
// the "LAST_MONTH" relative date range.
DateRange dateRange = new DateRange();
dateRange.setEndDate(new DateTime(true, System.currentTimeMillis(), null));

Calendar lastMonth = Calendar.getInstance();
lastMonth.add(Calendar.MONTH, -1);
dateRange.setStartDate(new DateTime(true, lastMonth.getTimeInMillis(), null));

// Create a report criteria.
Report.Criteria criteria = new Report.Criteria();
criteria.setDateRange(dateRange);
criteria.setDimensions(Lists.newArrayList(new SortedDimension().setName("advertiser")));
criteria.setMetricNames(Lists.newArrayList("clicks", "impressions"));

// Add the criteria to the report resource.
report.setCriteria(criteria);

PHP

// Define a date range to report on. This example uses explicit start and
// end dates to mimic the "LAST_30_DAYS" relative date range.
$dateRange = new Google_Service_Dfareporting_DateRange();
$dateRange->setStartDate(
    date('Y-m-d', mktime(0, 0, 0, date('m'), date('d') - 30, date('Y')))
);
$dateRange->setEndDate(date('Y-m-d'));

// Create a report criteria.
$dimension = new Google_Service_Dfareporting_SortedDimension();
$dimension->setName('advertiser');

$criteria = new Google_Service_Dfareporting_ReportCriteria();
$criteria->setDateRange($dateRange);
$criteria->setDimensions([$dimension]);
$criteria->setMetricNames(['clicks', 'impressions']);

// Add the criteria to the report resource.
$report->setCriteria($criteria);

Python

# Define a date range to report on. This example uses explicit start and end
# dates to mimic the "LAST_30_DAYS" relative date range.
end_date = date.today()
start_date = end_date - timedelta(days=30)

# Create a report criteria.
criteria = {
    'dateRange': {
        'startDate': start_date.strftime('%Y-%m-%d'),
        'endDate': end_date.strftime('%Y-%m-%d')
    },
    'dimensions': [{
        'name': 'advertiser'
    }],
    'metricNames': ['clicks', 'impressions']
}

# Add the criteria to the report resource.
report['criteria'] = criteria

Ruby

# Define a date range to report on. This example uses explicit start and end
# dates to mimic the "LAST_30_DAYS" relative date range.
start_date = DateTime.now.prev_day(30).strftime('%Y-%m-%d')
end_date = DateTime.now.strftime('%Y-%m-%d')

# Create a report criteria
criteria = DfareportingUtils::API_NAMESPACE::Report::Criteria.new(
  date_range: DfareportingUtils::API_NAMESPACE::DateRange.new(
    start_date: start_date,
    end_date: end_date
  ),
  dimensions: [
    DfareportingUtils::API_NAMESPACE::SortedDimension.new(
      name: 'advertiser'
    )
  ],
  metric_names: ['clicks', 'impressions']
)

# Add the criteria to the report resource.
report.criteria = criteria

フィルタ値をクエリする

レポートのフィルタを構成するときは、レポート出力を制限するためにフィルタが使用する値を正確に指定する必要があります。特定のフィルタで指定可能な値が不明な場合は、DimensionValues サービスを使用して検索します。

基本のディメンション値クエリには、ディメンション名、開始日、終了日が含まれます。開始日と終了日によって、レスポンスはその期間内に有効な値に制限されます。クエリ結果をさらに制限する必要がある場合は、追加のフィルタを指定できます。

以下の例では、レポートが作成された期間中に有効な広告主のフィルタ値を検索し、レポートの条件に追加しています。

C#

// Query advertiser dimension values for report run dates.
DimensionValueRequest request = new DimensionValueRequest();
request.StartDate = report.Criteria.DateRange.StartDate;
request.EndDate = report.Criteria.DateRange.EndDate;
request.DimensionName = "advertiser";

DimensionValueList values =
    service.DimensionValues.Query(request, profileId).Execute();

if (values.Items.Any()) {
  // Add a value as a filter to the report criteria.
  report.Criteria.DimensionFilters = new List<DimensionValue>() {
    values.Items[0]
  };
}

Java

// Query advertiser dimension values for report run dates.
DimensionValueRequest request = new DimensionValueRequest();
request.setStartDate(report.getCriteria().getDateRange().getStartDate());
request.setEndDate(report.getCriteria().getDateRange().getEndDate());
request.setDimensionName("advertiser");

DimensionValueList values = reporting.dimensionValues().query(profileId, request).execute();

if (!values.getItems().isEmpty()) {
  // Add a value as a filter to the report criteria.
  List<DimensionValue> filters = Lists.newArrayList(values.getItems().get(0));
  report.getCriteria().setDimensionFilters(filters);
}

PHP

// Query advertiser dimension values for report run dates.
$request = new Google_Service_Dfareporting_DimensionValueRequest();
$request->setStartDate(
    $report->getCriteria()->getDateRange()->getStartDate()
);
$request->setEndDate(
    $report->getCriteria()->getDateRange()->getEndDate()
);
$request->setDimensionName('advertiser');

$values =
    $this->service->dimensionValues->query($userProfileId, $request);

if (!empty($values->getItems())) {
    // Add a value as a filter to the report criteria.
    $report->getCriteria()->setDimensionFilters([$values->getItems()[0]]);
}

Python

# Query advertiser dimension values for report run dates.
request = {
    'dimensionName': 'advertiser',
    'endDate': report['criteria']['dateRange']['endDate'],
    'startDate': report['criteria']['dateRange']['startDate']
}

values = service.dimensionValues().query(
    profileId=profile_id, body=request).execute()

if values['items']:
  # Add a value as a filter to the report criteria.
  report['criteria']['dimensionFilters'] = [values['items'][0]]

Ruby

# Query advertiser dimension values for report run dates.
dimension = DfareportingUtils::API_NAMESPACE::DimensionValueRequest.new(
  dimension_name: 'advertiser',
  start_date: report.criteria.date_range.start_date,
  end_date: report.criteria.date_range.end_date
)

values = service.query_dimension_value(profile_id, dimension)

unless values.items.empty?
  # Add a value as a filter to the report criteria.
  report.criteria.dimension_filters = [values.items.first]
end

フィールドの互換性を判断する

レポートの条件を設定する際は、指標、ディメンション、フィルタのすべての組み合わせが有効とは限らないことに留意することが重要です。無効な組み合わせを含むレポートは保存できないため、使用する予定のフィールド同士の互換性を確認することが重要です。

レポートリソースを作成する際に、そのリソースを Reports.compatibleFields サービスに渡して、すでに選択したフィールドについて有効なフィールドを確認できます。レポートの構成が分析され、互換性のあるディメンション、指標、フィルタを含むレスポンスが返されます。このレスポンスに含まれるフィールドの相互互換性は保証されないため、選択したすべてのフィールドが連携するように、複数のリクエストを行う必要があります。

以下の例は、レポートリソースを入力として使用し、互換性のあるサンプルのフィールドをリクエストする方法を示しています。

C#

CompatibleFields fields =
    service.Reports.CompatibleFields.Query(report, profileId).Execute();

ReportCompatibleFields reportFields = fields.ReportCompatibleFields;

if(reportFields.Dimensions.Any()) {
  // Add a compatible dimension to the report.
  Dimension dimension = reportFields.Dimensions[0];
  SortedDimension sortedDimension = new SortedDimension();
  sortedDimension.Name = dimension.Name;
  report.Criteria.Dimensions.Add(sortedDimension);
} else if (reportFields.Metrics.Any()) {
  // Add a compatible metric to the report.
  Metric metric = reportFields.Metrics[0];
  report.Criteria.MetricNames.Add(metric.Name);
}

Java

CompatibleFields fields = reporting.reports().compatibleFields()
    .query(profileId, report).execute();

ReportCompatibleFields reportFields = fields.getReportCompatibleFields();

if (!reportFields.getDimensions().isEmpty()) {
  // Add a compatible dimension to the report.
  Dimension dimension = reportFields.getDimensions().get(0);
  SortedDimension sortedDimension = new SortedDimension().setName(dimension.getName());
  report.getCriteria().getDimensions().add(sortedDimension);
} else if (!reportFields.getMetrics().isEmpty()) {
  // Add a compatible metric to the report.
  Metric metric = reportFields.getMetrics().get(0);
  report.getCriteria().getMetricNames().add(metric.getName());
}

PHP

$fields = $this->service->reports_compatibleFields->query(
    $userProfileId,
    $report
);

$reportFields = $fields->getReportCompatibleFields();

if (!empty($reportFields->getDimensions())) {
    // Add a compatible dimension to the report.
    $dimension = $reportFields->getDimensions()[0];
    $sortedDimension = new Google_Service_Dfareporting_SortedDimension();
    $sortedDimension->setName($dimension->getName());
    $report->getCriteria()->setDimensions(
        array_merge(
            $report->getCriteria()->getDimensions(),
            [$sortedDimension]
        )
    );
} elseif (!empty($reportFields->getMetrics())) {
    // Add a compatible metric to the report.
    $metric = $reportFields->getMetrics()[0];
    $report->getCriteria()->setMetricNames(
        array_merge(
            $report->getCriteria()->getMetricNames(),
            [$metric->getName()]
        )
    );
}

Python

fields = service.reports().compatibleFields().query(
    profileId=profile_id, body=report).execute()

report_fields = fields['reportCompatibleFields']

if report_fields['dimensions']:
  # Add a compatible dimension to the report.
  report['criteria']['dimensions'].append({
      'name': report_fields['dimensions'][0]['name']
  })
elif report_fields['metrics']:
  # Add a compatible metric to the report.
  report['criteria']['metricNames'].append(
      report_fields['metrics'][0]['name'])

Ruby

fields = service.query_report_compatible_field(profile_id, report)

report_fields = fields.report_compatible_fields

if report_fields.dimensions.any?
  # Add a compatible dimension to the report.
  report.criteria.dimensions <<
    DfareportingUtils::API_NAMESPACE::SortedDimension.new(
      name: report_fields.dimensions.first.name
    )
elsif report_fields.metrics.any?
  # Add a compatible metric to the report.
  report.criteria.metric_names << report_fields.metrics.first.name
end

レポートを保存します

このプロセスの最後のステップとして、レポートリソースを保存します。新しいレポートを作成する場合は、Reports.insert を呼び出してそのレポートを挿入できます。

C#

Report insertedReport =
    service.Reports.Insert(report, profileId).Execute();

Java

Report insertedReport = reporting.reports().insert(profileId, report).execute();

PHP

$insertedReport =
    $this->service->reports->insert($userProfileId, $report);

Python

inserted_report = service.reports().insert(
    profileId=profile_id, body=report).execute()

Ruby

report = service.insert_report(profile_id, report)

部分的な更新を行う場合は、Reports.patch を呼び出して変更を保存できます。

C#

// Patch an existing report.
Report patchedReport =
    service.Reports.Patch(report, profileId, reportId).Execute();

Java

// Patch an existing report.
Report patchedReport = reporting.reports().patch(profileId, reportId, report).execute();

PHP

# Patch an existing report.
$patchedReport =
    $this->service->reports->patch($userProfileId, $reportId, $report)

Python

# Patch an existing report.
patched_report = service.reports().patch(
    profileId=profile_id, reportId=report_id, body=report).execute();

Ruby

# Patch an existing report.
patched_report = service.patch_report(profile_id, report_id, report)

完全な更新を行う場合は、Reports.update を呼び出して変更を保存することもできます。

C#

// Update an existing report.
Report updatedReport =
    service.Reports.Update(report, profileId, report.Id).Execute();

Java

// Update an existing report.
Report updatedReport = reporting.reports().update(profileId, report.getId(), report).execute();

PHP

# Update an existing report.
$updatedReport =
    $this->service->reports->update($userProfileId, $report->getId(), $report)

Python

# Update an existing report.
updated_report = service.reports().update(
    profileId=profile_id, reportId=report['id'], body=report).execute();

Ruby

# Update an existing report.
updated_report = service.update_report(profile_id, report.id, report);

保存リクエストが成功すると、レポートリソースのコピーがレスポンスの本文で返されます。このリソースでは、いくつかの新しいフィールドが入力されます。最も重要なフィールドは id フィールドです。この ID は、ワークフローの残りの部分で、このレポートを参照する際に使用します。

レポートを作成、更新する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

レポート リソースを構成する

C#

Java

PHP

Python

Ruby

レポートの条件を定義する

C#

Java

PHP

Python

Ruby

フィルタ値をクエリする

C#

Java

PHP

Python

Ruby

フィールドの互換性を判断する

C#

Java

PHP

Python

Ruby

レポートを保存します

C#

Java

PHP

Python

Ruby

C#

Java

PHP

Python

Ruby

C#

Java

PHP

Python

Ruby

レポートを作成、更新する

レポートリソースを構成する