Java
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.ads.googleads.examples.misc;
import com.beust.jcommander.Parameter;
import com.google.ads.googleads.examples.utils.ArgumentNames;
import com.google.ads.googleads.examples.utils.CodeSampleParams;
import com.google.ads.googleads.lib.GoogleAdsClient;
import com.google.ads.googleads.v14.errors.GoogleAdsError;
import com.google.ads.googleads.v14.errors.GoogleAdsException;
import com.google.ads.googleads.v14.services.GoogleAdsRow;
import com.google.ads.googleads.v14.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v14.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v14.services.SearchGoogleAdsRequest;
import java.io.FileNotFoundException;
import java.io.IOException;
/** Gets all image assets. */
public class GetAllImageAssets {
private static final int PAGE_SIZE = 1_000;
private static class GetAllImageAssetsParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
}
public static void main(String args[]) {
GetAllImageAssetsParams params = new GetAllImageAssetsParams();
if (!params.parseArguments(args)) {
// Either pass the required parameters for this example on the command line, or insert them
// into the code here. See the parameter class definition above for descriptions.
params.customerId = Long.parseLong("ENTER_CUSTOMER_ID_HERE");
}
GoogleAdsClient googleAdsClient = null;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
System.exit(1);
}
try {
new GetAllImageAssets().runExample(googleAdsClient, params.customerId);
} catch (GoogleAdsException gae) {
// GoogleAdsException is the base class for most exceptions thrown by an API request.
// Instances of this exception have a message and a GoogleAdsFailure that contains a
// collection of GoogleAdsErrors that indicate the underlying causes of the
// GoogleAdsException.
System.err.printf(
"Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
gae.getRequestId());
int i = 0;
for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
System.err.printf(" Error %d: %s%n", i++, googleAdsError);
}
System.exit(1);
}
}
/**
* Runs this example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private static void runExample(GoogleAdsClient googleAdsClient, long customerId) {
// Creates the search query.
String searchQuery =
"SELECT asset.name, "
+ "asset.image_asset.file_size, "
+ "asset.image_asset.full_size.width_pixels, "
+ "asset.image_asset.full_size.height_pixels, "
+ "asset.image_asset.full_size.url "
+ "FROM asset "
+ "WHERE asset.type = 'IMAGE'";
// Creates the request.
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setPageSize(PAGE_SIZE)
.setReturnTotalResultsCount(true)
.setQuery(searchQuery)
.build();
// Creates the Google Ads Service Client.
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
// Issues the search request.
SearchPagedResponse response = googleAdsServiceClient.search(request);
// Displays a response if no images are found.
if (response.getPage().getResponse().getTotalResultsCount() == 0) {
System.out.printf("No image assets found.%n");
}
// Iterates over each row of the response.
for (GoogleAdsRow row : response.iterateAll()) {
// Displays the results.
System.out.printf(
"Image with name '%s', file size %d bytes, width %dpx, height %dpx, and url '%s' "
+ "found.%n",
row.getAsset().getName(),
row.getAsset().getImageAsset().getFileSize(),
row.getAsset().getImageAsset().getFullSize().getWidthPixels(),
row.getAsset().getImageAsset().getFullSize().getHeightPixels(),
row.getAsset().getImageAsset().getFullSize().getUrl());
}
}
}
}
C#
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using CommandLine;
using Google.Ads.Gax.Examples;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V14.Common;
using Google.Ads.GoogleAds.V14.Errors;
using Google.Ads.GoogleAds.V14.Resources;
using Google.Ads.GoogleAds.V14.Services;
using Google.Api.Gax;
using System;
using System.Collections.Generic;
using System.Linq;
namespace Google.Ads.GoogleAds.Examples.V14
{
/// <summary>
/// This code example gets all image assets.
/// </summary>
public class GetAllImageAssets : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GetAllImageAssets"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public long CustomerId { get; set; }
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
Options options = ExampleUtilities.ParseCommandLine<Options>(args);
GetAllImageAssets codeExample = new GetAllImageAssets();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId);
return;
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description => "This code example gets all image assets.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
public void Run(GoogleAdsClient client, long customerId)
{
// Get the GoogleAdsServiceClient.
GoogleAdsServiceClient googleAdsService =
client.GetService(Services.V14.GoogleAdsService);
// Creates the search query.
string searchQuery = "SELECT asset.name, asset.image_asset.file_size, " +
"asset.image_asset.full_size.width_pixels, " +
"asset.image_asset.full_size.height_pixels, " +
"asset.image_asset.full_size.url FROM asset WHERE asset.type = 'IMAGE'";
// Creates the request.
SearchGoogleAdsRequest request = new SearchGoogleAdsRequest()
{
CustomerId = customerId.ToString(),
Query = searchQuery,
ReturnTotalResultsCount = true
};
try
{
// Issue the search request.
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> searchPagedResponse =
googleAdsService.Search(request);
long totalImageAssetCount = searchPagedResponse.AsRawResponses()
.First().TotalResultsCount;
foreach (GoogleAdsRow row in searchPagedResponse)
{
Asset asset = row.Asset;
ImageAsset imageAsset = asset.ImageAsset;
// Displays the results.
Console.WriteLine($"Image with name '{asset.Name}', file size " +
$"{imageAsset.FileSize} bytes, width {imageAsset.FullSize.WidthPixels}px," +
$" height {imageAsset.FullSize.HeightPixels}px, and url " +
$"'{imageAsset.FullSize.Url}' found.");
}
Console.WriteLine($"Total image assets found: {totalImageAssetCount}");
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
}
}
PHP
<?php
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Ads\GoogleAds\Examples\Misc;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V14\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V14\Services\GoogleAdsRow;
use Google\Ads\GoogleAds\V14\Services\SearchGoogleAdsRequest;
use Google\ApiCore\ApiException;
/** This example gets all image assets. */
class GetAllImageAssets
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const PAGE_SIZE = 1000;
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT
]);
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile()
->withOAuth2Credential($oAuth2Credential)
// We set this value to true to show how to use GAPIC v2 source code. You can remove the
// below line if you wish to use the old-style source code. Note that in that case, you
// probably need to modify some parts of the code below to make it work.
// For more information, see
// https://developers.devsite.corp.google.com/google-ads/api/docs/client-libs/php/gapic.
->usingGapicV2Source(true)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID
);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
*/
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that will retrieve all image assets.
$query = "SELECT asset.name, " .
"asset.image_asset.file_size, " .
"asset.image_asset.full_size.width_pixels, " .
"asset.image_asset.full_size.height_pixels, " .
"asset.image_asset.full_size.url " .
"FROM asset WHERE asset.type = 'IMAGE'";
// Issues a search request by specifying page size.
$response = $googleAdsServiceClient->search(
SearchGoogleAdsRequest::build($customerId, $query)
->setPageSize(self::PAGE_SIZE)
->setReturnTotalResultsCount(true)
);
// Iterates over all rows in all pages and prints the requested field values for the image
// asset in each row.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
printf(
"Image with name '%s', file size %d bytes, width %dpx, height %dpx, " .
"and URL '%s' was found.%s",
$googleAdsRow->getAsset()->getName(),
$googleAdsRow->getAsset()->getImageAsset()->getFileSize(),
$googleAdsRow
->getAsset()->getImageAsset()->getFullSize()->getWidthPixels(),
$googleAdsRow
->getAsset()->getImageAsset()->getFullSize()->getHeightPixels(),
$googleAdsRow->getAsset()->getImageAsset()->getFullSize()->getUrl(),
PHP_EOL
);
}
printf(
"Number of images found: %d.%s",
$response->getPage()->getResponseObject()->getTotalResultsCount(),
PHP_EOL
);
}
}
GetAllImageAssets::main();
Python
#!/usr/bin/env python
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This code example gets all image assets."""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
_DEFAULT_PAGE_SIZE = 1000
def main(client, customer_id, page_size):
"""Main method, to run this code example as a standalone application."""
ga_service = client.get_service("GoogleAdsService")
query = """
SELECT
asset.name,
asset.image_asset.file_size,
asset.image_asset.full_size.width_pixels,
asset.image_asset.full_size.height_pixels,
asset.image_asset.full_size.url
FROM asset
WHERE asset.type = IMAGE"""
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = query
search_request.page_size = page_size
results = ga_service.search(search_request)
results = ga_service.search(request=search_request)
count = 0
for row in results:
asset = row.asset
image_asset = asset.image_asset
count += 1
print(
f'Image with name "{asset.name}" found:\n'
f"\tfile size {image_asset.file_size} bytes\n"
f"\twidth {image_asset.full_size.width_pixels}px\n"
f"\theight {image_asset.full_size.height_pixels}px\n"
f'\turl "{image_asset.full_size.url}"'
)
print(f"Total of {count} image(s) found.")
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v14")
parser = argparse.ArgumentParser(
description="List all image assets for specified customer."
)
# The following argument(s) should be provided to run the example.
parser.add_argument(
"-c",
"--customer_id",
type=str,
required=True,
help="The Google Ads customer ID.",
)
args = parser.parse_args()
try:
main(googleads_client, args.customer_id, _DEFAULT_PAGE_SIZE)
except GoogleAdsException as ex:
print(
f'Request with ID "{ex.request_id}" failed with status '
f'"{ex.error.code().name}" and includes the following errors:'
)
for error in ex.failure.errors:
print(f'\tError with message "{error.message}".')
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn field: {field_path_element.field_name}")
sys.exit(1)
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This code example gets all image assets.
require 'optparse'
require 'google/ads/google_ads'
def get_all_image_assets(customer_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
query = <<~EOQUERY
SELECT asset.name, asset.image_asset.file_size,
asset.image_asset.full_size.width_pixels,
asset.image_asset.full_size.height_pixels,
asset.image_asset.full_size.url FROM asset
WHERE asset.type = IMAGE
EOQUERY
ga_service = client.service.google_ads
response = ga_service.search(customer_id: customer_id, query: query)
count = 0
response.each do |row|
asset = row.asset
image_asset = asset.image_asset
count += 1
puts(
"Image with name #{asset.name} found:\n"\
"\tfile size #{image_asset.file_size} bytes\n"\
"\twidth #{image_asset.full_size.width_pixels}px\n"\
"\theight #{image_asset.full_size.height_pixels}px\n"\
"\turl '#{image_asset.full_size.url}'"
)
end
puts("Total of #{count} image asset#{if count > 1 then 's' else '' end} found")
end
if __FILE__ == $0
options = {}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options[:customer_id] = 'INSERT_CUSTOMER_ID_HERE'
OptionParser.new do |opts|
opts.banner = sprintf('Usage: add_campaigns.rb [options]')
opts.separator ''
opts.separator 'Options:'
opts.on('-C', '--customer-id CUSTOMER-ID', String, 'Customer ID') do |v|
options[:customer_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
get_all_image_assets(options.fetch(:customer_id).tr('-', ''))
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
e.failure.errors.each do |error|
STDERR.printf('Error with message: %s\n', error.message)
if error.location
error.location.field_path_elements.each do |field_path_element|
STDERR.printf('\tOn field: %s\n', field_path_element.field_name)
end
end
error.error_code.to_h.each do |k, v|
next if v == :UNSPECIFIED
STDERR.printf('\tType: %s\n\tCode: %s\n', k, v)
end
end
raise
end
end
Perl
#!/usr/bin/perl -w
#
# Copyright 2019, Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example gets all image assets.
use strict;
use warnings;
use utf8;
use FindBin qw($Bin);
use lib "$Bin/../../lib";
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::Utils::GoogleAdsHelper;
use Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator;
use
Google::Ads::GoogleAds::V14::Services::GoogleAdsService::SearchGoogleAdsRequest;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use constant PAGE_SIZE => 1000;
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my $customer_id = "INSERT_CUSTOMER_ID_HERE";
sub get_all_image_assets {
my ($api_client, $customer_id) = @_;
# Create the search query.
my $search_query =
"SELECT asset.name, asset.image_asset.file_size, " .
"asset.image_asset.full_size.width_pixels, " .
"asset.image_asset.full_size.height_pixels, " .
"asset.image_asset.full_size.url " .
"FROM asset WHERE asset.type = 'IMAGE'";
# Create a search Google Ads request that will retrieve all image assets
# using pages of the specified page size.
my $search_request =
Google::Ads::GoogleAds::V14::Services::GoogleAdsService::SearchGoogleAdsRequest
->new({
customerId => $customer_id,
query => $search_query,
pageSize => PAGE_SIZE,
returnTotalResultsCount => "true"
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
my $iterator = Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator->new({
service => $google_ads_service,
request => $search_request
});
# Iterate over all rows in all pages and print the requested field values for
# the image asset in each row.
while ($iterator->has_next) {
my $google_ads_row = $iterator->next;
printf "Image with name '%s', file size %d bytes, width %dpx, " .
"height %dpx, and url '%s' was found.\n",
$google_ads_row->{asset}{name},
$google_ads_row->{asset}{imageAsset}{fileSize},
$google_ads_row->{asset}{imageAsset}{fileSize},
$google_ads_row->{asset}{imageAsset}{fullSize}{widthPixels},
$google_ads_row->{asset}{imageAsset}{fullSize}{heightPixels};
}
printf
"Number of images found: %d.\n",
$iterator->get_current_response()->{totalResultsCount} || 0;
return 1;
}
# Don't run the example if the file is being included.
if (abs_path($0) ne abs_path(__FILE__)) {
return 1;
}
# Get Google Ads Client, credentials will be read from ~/googleads.properties.
my $api_client = Google::Ads::GoogleAds::Client->new();
# By default examples are set to die on any server returned fault.
$api_client->set_die_on_faults(1);
# Parameters passed on the command line will override any parameters set in code.
GetOptions("customer_id=s" => \$customer_id);
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage(2) if not check_params($customer_id);
# Call the example.
get_all_image_assets($api_client, $customer_id =~ s/-//gr);
=pod
=head1 NAME
get_all_image_assets
=head1 DESCRIPTION
This example gets all image assets.
=head1 SYNOPSIS
get_all_image_assets.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
=cut
