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.v13.enums.MediaTypeEnum.MediaType; import com.google.ads.googleads.v13.errors.GoogleAdsError; import com.google.ads.googleads.v13.errors.GoogleAdsException; import com.google.ads.googleads.v13.resources.MediaFile; import com.google.ads.googleads.v13.resources.MediaImage; import com.google.ads.googleads.v13.services.MediaFileOperation; import com.google.ads.googleads.v13.services.MediaFileServiceClient; import com.google.ads.googleads.v13.services.MutateMediaFileResult; import com.google.ads.googleads.v13.services.MutateMediaFilesResponse; import com.google.common.io.ByteStreams; import com.google.protobuf.ByteString; import java.io.FileNotFoundException; import java.io.IOException; import java.net.URL; import java.util.Arrays; /** Uploads an image. */ public class UploadImage { private static class UploadImageParams extends CodeSampleParams { @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true) private Long customerId; } public static void main(String[] args) throws IOException { UploadImageParams params = new UploadImageParams(); 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("INSERT_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 UploadImage().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 the 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 void runExample(GoogleAdsClient googleAdsClient, long customerId) throws IOException { byte[] imageData = ByteStreams.toByteArray(new URL("https://gaagl.page.link/Eit5").openStream()); MediaImage image = MediaImage.newBuilder().setData(ByteString.copyFrom(imageData)).build(); MediaFile file = MediaFile.newBuilder() .setName("Ad Image") .setType(MediaType.IMAGE) .setSourceUrl("https://gaagl.page.link/Eit5") .setImage(image) .build(); MediaFileOperation op = MediaFileOperation.newBuilder().setCreate(file).build(); try (MediaFileServiceClient mediaFileServiceClient = googleAdsClient.getLatestVersion().createMediaFileServiceClient()) { MutateMediaFilesResponse response = mediaFileServiceClient.mutateMediaFiles(Long.toString(customerId), Arrays.asList(op)); System.out.printf("Added %d images:%n", response.getResultsCount()); for (MutateMediaFileResult result : response.getResultsList()) { System.out.println(result.getResourceName()); } } } }
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.Gax.Util; using Google.Ads.GoogleAds.Lib; using Google.Ads.GoogleAds.Util; using Google.Ads.GoogleAds.V13.Errors; using Google.Ads.GoogleAds.V13.Resources; using Google.Ads.GoogleAds.V13.Services; using Google.Protobuf; using System; using System.Collections.Generic; using static Google.Ads.GoogleAds.V13.Enums.MediaTypeEnum.Types; namespace Google.Ads.GoogleAds.Examples.V13 { /// <summary> /// This code example uploads an image. /// </summary> public class UploadImage : ExampleBase { /// <summary> /// Command line options for running the <see cref="UploadImage"/> example. /// </summary> public class Options : OptionsBase { /// <summary> /// The customer ID for which the call is made. /// </summary> [Option("customerId", Required = true, HelpText = "The 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); UploadImage codeExample = new UploadImage(); Console.WriteLine(codeExample.Description); codeExample.Run(new GoogleAdsClient(), options.CustomerId); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description => "This code example uploads an image."; /// <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 MediaFileServiceClient. MediaFileServiceClient mediaFileService = client.GetService(Services.V13.MediaFileService); const string URL = "https://gaagl.page.link/Eit5"; MediaFile file = new MediaFile() { Name = "Ad Image", Type = MediaType.Image, SourceUrl = URL, Image = new MediaImage() { Data = ByteString.CopyFrom(MediaUtilities.GetAssetDataFromUrl( URL, client.Config)) } }; MediaFileOperation operation = new MediaFileOperation() { Create = file }; try { MutateMediaFilesResponse response = mediaFileService.MutateMediaFiles(customerId.ToString(), new[] { operation }); Console.WriteLine($"Added {response.Results} images:"); foreach (MutateMediaFileResult result in response.Results) { Console.WriteLine(result.ResourceName); } } 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\V13\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V13\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V13\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\V13\Enums\MediaTypeEnum\MediaType; use Google\Ads\GoogleAds\V13\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V13\Resources\MediaFile; use Google\Ads\GoogleAds\V13\Resources\MediaImage; use Google\Ads\GoogleAds\V13\Services\MediaFileOperation; use Google\ApiCore\ApiException; /** This example uploads an image. */ class UploadImage { private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; private const IMAGE_URL = 'https://gaagl.page.link/Eit5'; 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) ->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) { // Creates an image content. $imageContent = file_get_contents(self::IMAGE_URL); // Creates a media file. $mediaFile = new MediaFile([ 'name' => 'Ad Image', 'type' => MediaType::IMAGE, 'source_url' => self::IMAGE_URL, 'image' => new MediaImage(['data' => $imageContent]) ]); // Creates a media file operation. $mediaFileOperation = new MediaFileOperation(); $mediaFileOperation->setCreate($mediaFile); // Issues a mutate request to add the media file. $mediaFileServiceClient = $googleAdsClient->getMediaFileServiceClient(); $response = $mediaFileServiceClient->mutateMediaFiles( $customerId, [$mediaFileOperation] ); printf("Added %d images:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $addedMediaFile) { /** @var MediaFile $addedMediaFile */ printf( "New image added with resource name: '%s'%s", $addedMediaFile->getResourceName(), PHP_EOL ); } } } UploadImage::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 uploads an image.""" import argparse import sys import requests from google.ads.googleads.client import GoogleAdsClient from google.ads.googleads.errors import GoogleAdsException def main(client, customer_id): """Main method, to run this code example as a standalone application.""" url = "https://gaagl.page.link/Eit5" media_file_service = client.get_service("MediaFileService") media_file_operation = client.get_type("MediaFileOperation") media_file = media_file_operation.create media_file.name = "Ad Image" media_file.type_ = client.enums.MediaTypeEnum.IMAGE media_file.source_url = url # Download the image as bytes from the URL media_file.image.data = requests.get(url).content mutate_media_files_response = media_file_service.mutate_media_files( customer_id=customer_id, operations=[media_file_operation] ) print("Uploaded file(s):") for row in mutate_media_files_response.results: print(f"\tResource name: {row.resource_name}") 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="v13") parser = argparse.ArgumentParser(description="Upload an image from a URL.") # 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) 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 2018 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 example uploads an image require 'optparse' require 'google/ads/google_ads' require 'open-uri' def upload_image(customer_id) image_data = open("https://gaagl.page.link/Eit5") { |f| f.read } # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new operation = client.operation.create_resource.media_file do |media_file| media_file.type = :IMAGE media_file.image = client.resource.media_image do |media_image| media_image.data = image_data end end media_file_service = client.service.media_file response = media_file_service.mutate_media_files( customer_id: customer_id, operations: [operation], ) puts("Uploaded media file with id: #{response.results.first.resource_name}") 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: %s [options]', File.basename(__FILE__)) 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 upload_image(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 uploads an image. 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::MediaUtils; use Google::Ads::GoogleAds::V13::Resources::MediaImage; use Google::Ads::GoogleAds::V13::Resources::MediaFile; use Google::Ads::GoogleAds::V13::Enums::MediaTypeEnum qw(IMAGE); use Google::Ads::GoogleAds::V13::Services::MediaFileService::MediaFileOperation; use Getopt::Long qw(:config auto_help); use Pod::Usage; use Cwd qw(abs_path); use constant IMAGE_URL => "https://gaagl.page.link/Eit5"; # 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 upload_image { my ($api_client, $customer_id) = @_; # Create a media image. my $media_image = Google::Ads::GoogleAds::V13::Resources::MediaImage->new({ data => get_base64_data_from_url(IMAGE_URL)}); # Create a media file. my $media_file = Google::Ads::GoogleAds::V13::Resources::MediaFile->new({ name => "Ad Images", type => IMAGE, sourceUrl => IMAGE_URL, image => $media_image }); # Create a media file operation. my $media_file_operation = Google::Ads::GoogleAds::V13::Services::MediaFileService::MediaFileOperation ->new({ create => $media_file }); # Add the media file. my $media_files_response = $api_client->MediaFileService()->mutate({ customerId => $customer_id, operations => [$media_file_operation]}); printf "Uploaded media file with resource name: '%s'.\n", $media_files_response->{results}[0]{resourceName}; 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. upload_image($api_client, $customer_id =~ s/-//gr); =pod =head1 NAME upload_image =head1 DESCRIPTION This example uploads an image. =head1 SYNOPSIS upload_image.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. =cut