Campaign Manager 360 API v3.4 はサポートが終了し、2022 年 1 月 10 日に廃止されます。この日までに、すべてのユーザーが新しいバージョンの API に移行する必要があります。

レポート ファイルのダウンロード

キャンペーン マネージャー 360 API を使って、レポート ビルダーのレポート結果を含むファイルをダウンロードすることができます。リンクを提供して、ユーザーがファイルに直接アクセスできるようにすることも可能です。

実行するダウンロードの種類に応じて、以下のいずれかの方法を利用します。

  • 直接ダウンロード - Files.getalt=media パラメータを指定します。
  • ブラウザでファイルをダウンロード - Files リソースの browserUrl を使用します。

このガイドでは、上記のダウンロードを Files リソースを使用して行う手順について詳しく説明します。

事前準備

ファイルをダウンロードするには、以下の情報が必要となります。

  1. ファイルが属するレポートの ID。レポート ID は、新しいレポートを作成するか、既存のレポートを検索することで確認できます。
  2. ダウンロードするファイルの ID。これは、前の手順を参考にしてレポートを実行するか、下記の例のように既存のファイルのリストを検索して調べることができます。

C#

File target = null;
FileList files;
String nextPageToken = null;

do {
  // Create and execute the files list request.
  ReportsResource.FilesResource.ListRequest request =
      service.Reports.Files.List(profileId, reportId);
  request.PageToken = nextPageToken;
  files = request.Execute();

  foreach (File file in files.Items) {
    if (IsTargetFile(file)) {
      target = file;
      break;
    }
  }

  // Update the next page token.
  nextPageToken = files.NextPageToken;
} while (target == null
    && files.Items.Any()
    && !String.IsNullOrEmpty(nextPageToken));

Java

File target = null;
FileList files;
String nextPageToken = null;

do {
  // Create and execute the files list request.
  files = reporting.reports().files().list(profileId, reportId).setPageToken(nextPageToken)
      .execute();

  for (File file : files.getItems()) {
    if (isTargetFile(file)) {
      target = file;
      break;
    }
  }

  // Update the next page token.
  nextPageToken = files.getNextPageToken();
} while (target == null
    && !files.getItems().isEmpty()
    && !Strings.isNullOrEmpty(nextPageToken));

PHP

$target = null;
$response = null;
$pageToken = null;

do {
    // Create and execute the file list request.
    $response = $this->service->reports_files->listReportsFiles(
        $userProfileId,
        $reportId,
        ['pageToken' => $pageToken]
    );

    foreach ($response->getItems() as $file) {
        if ($this->isTargetFile($file)) {
            $target = $file;
            break;
        }
    }

    $pageToken = $response->getNextPageToken();
} while (empty($target) && !empty($response->getItems()) && !empty($pageToken));

Python

target = None

request = service.reports().files().list(
    profileId=profile_id, reportId=report_id)

while True:
  response = request.execute()

  for report_file in response['items']:
    if is_target_file(report_file):
      target = report_file
      break

  if not target and response['items'] and response['nextPageToken']:
    request = service.reports().files().list_next(request, response)
  else:
    break

Ruby

page_token = nil
target = nil

loop do
  result = service.list_report_files(profile_id, report_id,
    page_token: page_token)

  result.items.each do |file|
    if target_file?(file)
      target = file
      break
    end
  end

  page_token = (result.next_page_token if target.nil? && result.items.any?)
  break if page_token.to_s.empty?
end

ダウンロードできるようにするには、ファイル リソースの status フィールドを REPORT_AVAILABLE に設定する必要があります。

直接ダウンロード

直接ダウンロードするには、クエリ パラメータ alt=media を指定して、認証済みの HTTP GET リクエストを Files サービスに対して行います。リクエストは次のようになります。

GET https://www.googleapis.com/dfareporting/v3.4/reports/12345/files/12345?alt=media HTTP/1.1
Authorization: Bearer your_auth_token

受け取るレスポンスにはリダイレクトが含まれているため、アプリケーションで自動的に処理するように設定することをおすすめします。手動で処理する場合は、レスポンスの Location ヘッダーにあるリダイレクト URL を使用します。

正規の Google クライアント ライブラリのほとんどで、直接ダウンロードを開始するための下記のような便利なメソッドが用意されています。ダウンロードを手動で開始する場合は、ファイル リソースの apiUrl フィールドにある事前設定の URL を使用できます。

C#

// Retrieve the file metadata.
File file = service.Files.Get(reportId, fileId).Execute();

if ("REPORT_AVAILABLE".Equals(file.Status)) {
  // Create a get request.
  FilesResource.GetRequest getRequest = service.Files.Get(reportId, fileId);

  // Optional: adjust the chunk size used when downloading the file.
  // getRequest.MediaDownloader.ChunkSize = MediaDownloader.MaximumChunkSize;

  // Execute the get request and download the file.
  using (System.IO.FileStream outFile = new System.IO.FileStream(GenerateFileName(file),
      System.IO.FileMode.Create, System.IO.FileAccess.Write)) {
    getRequest.Download(outFile);
    Console.WriteLine("File {0} downloaded to {1}", file.Id, outFile.Name);
  }
}

Java

// Retrieve the file metadata.
File file = reporting.files().get(reportId, fileId).execute();

if ("REPORT_AVAILABLE".equals(file.getStatus())) {
  // Prepare a local file to download the report contents to.
  java.io.File outFile = new java.io.File(Files.createTempDir(), generateFileName(file));

  // Create a get request.
  Get getRequest = reporting.files().get(reportId, fileId);

  // Optional: adjust the chunk size used when downloading the file.
  // getRequest.getMediaHttpDownloader().setChunkSize(MediaHttpDownloader.MAXIMUM_CHUNK_SIZE);

  // Execute the get request and download the file.
  try (OutputStream stream = new FileOutputStream(outFile)) {
    getRequest.executeMediaAndDownloadTo(stream);
  }

  System.out.printf("File %d downloaded to %s%n", file.getId(), outFile.getAbsolutePath());
}

PHP

// Retrieve the file metadata.
$file = $this->service->files->get($reportId, $fileId);

if ($file->getStatus() === 'REPORT_AVAILABLE') {
    try {
        // Prepare a local file to download the report contents to.
        $fileName = join(
            DIRECTORY_SEPARATOR,
            [sys_get_temp_dir(), $this->generateFileName($file)]
        );
        $fileResource = fopen($fileName, 'w+');
        $fileStream = \GuzzleHttp\Psr7\stream_for($fileResource);

        // Execute the get request and download the file.
        $httpClient = $this->service->getClient()->authorize();
        $result = $httpClient->request(
            'GET',
            $file->getUrls()->getApiUrl(),
            [\GuzzleHttp\RequestOptions::SINK => $fileStream]
        );

        printf('<h3>Report file saved to: %s</h3>', $fileName);
    } finally {
        $fileStream->close();
        fclose($fileResource);
    }
}

Python

# Retrieve the file metadata.
report_file = service.files().get(
    reportId=report_id, fileId=file_id).execute()

if report_file['status'] == 'REPORT_AVAILABLE':
  # Prepare a local file to download the report contents to.
  out_file = io.FileIO(generate_file_name(report_file), mode='wb')

  # Create a get request.
  request = service.files().get_media(reportId=report_id, fileId=file_id)

  # Create a media downloader instance.
  # Optional: adjust the chunk size used when downloading the file.
  downloader = http.MediaIoBaseDownload(
      out_file, request, chunksize=CHUNK_SIZE)

  # Execute the get request and download the file.
  download_finished = False
  while download_finished is False:
    _, download_finished = downloader.next_chunk()

  print('File %s downloaded to %s' % (report_file['id'],
                                      os.path.realpath(out_file.name)))

Ruby

# Retrieve the file metadata.
report_file = service.get_file(report_id, file_id)
return unless report_file.status == 'REPORT_AVAILABLE'

# Prepare a local file to download the report contents to.
File.open(generate_file_name(report_file), 'w') do |out_file|
  # Execute the download request. Providing a download destination
  # retrieves the file contents rather than the file metadata.
  service.get_file(report_id, file_id, download_dest: out_file)

  puts format('File %s downloaded to %s', file_id,
    File.absolute_path(out_file.path))
end

再開可能なダウンロード

大きなレポート ファイルをダウンロードする場合、途中でダウンロードが失敗する可能性があります。失敗したダウンロードを復元して再開できるよう、ファイル サービスで部分的なダウンロードの機能がサポートされています。

部分的ダウンロードでは、ファイルの特定の部分をリクエストする機能によって、大きなダウンロードを小さく分割できます。ダウンロードするファイルの部分を指定するには、リクエストの Range HTTP ヘッダーにバイトの範囲を指定します。例を次に示します。

Range: bytes=500-999

部分的ダウンロード機能は、メディア ダウンロード サービスを通して、多くのクライアント ライブラリで提供されています。詳しくは、クライアント ライブラリのドキュメントをご覧ください。

ブラウザ内でのファイルのダウンロード

ユーザーがウェブブラウザからファイルを直接ダウンロードできるようにするには、Files リソースの browserUrl フィールドで提供される URL を使用します。この URL にユーザーをリダイレクトするか、クリック可能なリンクを提示します。いずれの場合も、ダウンロードを開始するには、ユーザーがキャンペーン マネージャー 360 レポートへのアクセス権がある Google アカウントにログインしていて、指定するファイルへの適切なアクセス権を持っている必要があります。

C#

File file = service.Files.Get(reportId, fileId).Execute();
String browserUrl = file.Urls.BrowserUrl;

Java

File file = reporting.files().get(reportId, fileId).execute();
String browserUrl = file.getUrls().getBrowserUrl();

PHP

$file = $this->service->files->get($reportId, $fileId);
$browserUrl = $file->getUrls()->getBrowserUrl();

Python

report_file = service.files().get(
    reportId=report_id, fileId=file_id).execute()
browser_url = report_file['urls']['browserUrl']

Ruby

report_file = service.get_file(report_id, file_id)
browser_url = report_file.urls.browser_url