Upload Image Asset
Stay organized with collections
Save and categorize content based on your preferences.
Java
//
// 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.
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.v21.common.ImageAsset
;
import
com.google.ads.googleads.v21.enums.AssetTypeEnum.AssetType
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.resources.Asset
;
import
com.google.ads.googleads.v21.services.AssetOperation
;
import
com.google.ads.googleads.v21.services.AssetServiceClient
;
import
com.google.ads.googleads.v21.services.MutateAssetsResponse
;
import
com.google.common.collect.ImmutableList
;
import
com.google.common.io.ByteStreams
;
import
com.google.protobuf.ByteString
;
import
java.io.FileNotFoundException
;
import
java.io.IOException
;
import
java.net.URL
;
/** Uploads an image asset. To get image assets, run GetAllImageAssets.java */
public
class
UploadImageAsset
{
private
static
final
String
IMAGE_URL
=
"https://gaagl.page.link/Eit5"
;
private
static
class
UploadImageAssetParams
extends
CodeSampleParams
{
@Parameter
(
names
=
ArgumentNames
.
CUSTOMER_ID
,
required
=
true
)
private
Long
customerId
;
}
public
static
void
main
(
String
[]
args
)
throws
IOException
{
UploadImageAssetParams
params
=
new
UploadImageAssetParams
();
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
UploadImageAsset
().
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 IOException if there are errors related to image processing.
*/
private
void
runExample
(
GoogleAdsClient
googleAdsClient
,
long
customerId
)
throws
IOException
{
byte
[]
imageData
=
ByteStreams
.
toByteArray
(
new
URL
(
IMAGE_URL
).
openStream
());
// Create the image asset.
ImageAsset
imageAsset
=
ImageAsset
.
newBuilder
().
setData
(
ByteString
.
copyFrom
(
imageData
)).
build
();
// Creates an asset.
Asset
asset
=
Asset
.
newBuilder
()
// Provide a unique friendly name to identify your asset.
// When there is an existing image asset with the same content but a different name, the
// new name will be dropped silently.
.
setName
(
"Marketing Image"
)
.
setType
(
AssetType
.
IMAGE
)
.
setImageAsset
(
imageAsset
)
.
build
();
// Creates the operation.
AssetOperation
operation
=
AssetOperation
.
newBuilder
().
setCreate
(
asset
).
build
();
// Creates the service client.
try
(
AssetServiceClient
assetServiceClient
=
googleAdsClient
.
getLatestVersion
().
createAssetServiceClient
())
{
// Issues a mutate request to add the asset.
MutateAssetsResponse
response
=
assetServiceClient
.
mutateAssets
(
Long
.
toString
(
customerId
),
ImmutableList
.
of
(
operation
));
// Prints the result.
System
.
out
.
printf
(
"The image asset with resource name '%s' was created.%n"
,
response
.
getResults
(
0
).
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.V21.Common
;
using
Google.Ads.GoogleAds.V21.Errors
;
using
Google.Ads.GoogleAds.V21.Resources
;
using
Google.Ads.GoogleAds.V21.Services
;
using
Google.Protobuf
;
using
System
;
using
System.Collections.Generic
;
using
System.Linq
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
AssetTypeEnum
.
Types
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
MimeTypeEnum
.
Types
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example uploads an image asset. To get image assets, run GetAllImageAssets.cs.
/// </summary>
public
class
UploadImageAsset
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="UploadImageAsset"/> 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
);
UploadImageAsset
codeExample
=
new
UploadImageAsset
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
);
}
/// <summary>
/// The image URL to upload as asset.
/// </summary>
private
const
string
IMAGE_URL
=
"https://gaagl.page.link/Eit5"
;
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
>
"This code example uploads an image asset. To get image assets, run "
+
"GetAllImageAssets.cs."
;
/// <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 AssetServiceClient.
AssetServiceClient
assetService
=
client
.
GetService
(
Services
.
V21
.
AssetService
);
// Creates an image content.
byte
[]
imageContent
=
MediaUtilities
.
GetAssetDataFromUrl
(
IMAGE_URL
,
client
.
Config
);
// Creates an image asset.
ImageAsset
imageAsset
=
new
ImageAsset
()
{
Data
=
ByteString
.
CopyFrom
(
imageContent
),
FileSize
=
imageContent
.
Length
,
MimeType
=
MimeType
.
ImageJpeg
,
FullSize
=
new
ImageDimension
()
{
HeightPixels
=
315
,
WidthPixels
=
600
,
Url
=
IMAGE_URL
}
};
// Creates an asset.
Asset
asset
=
new
Asset
()
{
// Optional: Provide a unique friendly name to identify your asset.
// If you specify the name field, then both the asset name and the image being
// uploaded should be unique, and should not match another ACTIVE asset in this
// customer account.
// Name = 'Jupiter Trip #' + ExampleUtilities.GetRandomString(),
Type
=
AssetType
.
Image
,
ImageAsset
=
imageAsset
,
// Provide a unique friendly name to identify your asset.
// When there is an existing image asset with the same content but a different
// name, the new name will be dropped silently.
Name
=
"Marketing Image"
};
// Creates an asset operation.
AssetOperation
operation
=
new
AssetOperation
()
{
Create
=
asset
};
try
{
// Issues a mutate request to add the asset.
MutateAssetsResponse
response
=
assetService
.
MutateAssets
(
customerId
.
ToString
(),
new
[]
{
operation
});
// Displays the result.
Console
.
WriteLine
(
$"Image asset with resource name: "
+
$"'{response.Results.First().ResourceName}' is created."
);
}
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 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.
*/
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\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsException;
use Google\Ads\GoogleAds\V21\Common\ImageAsset;
use Google\Ads\GoogleAds\V21\Enums\AssetTypeEnum\AssetType;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Resources\Asset;
use Google\Ads\GoogleAds\V21\Services\AssetOperation;
use Google\Ads\GoogleAds\V21\Services\MutateAssetResult;
use Google\Ads\GoogleAds\V21\Services\MutateAssetsRequest;
use Google\ApiCore\ApiException;
/** This example uploads an image asset. To get image assets, run GetAllImageAssets.php. */
class UploadImageAsset
{
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 an asset.
$asset = new Asset([
// Provide a unique friendly name to identify your asset.
// When there is an existing image asset with the same content but a different
// name, the new name will be dropped silently.
'name' => 'Marketing Image',
'type' => AssetType::IMAGE,
'image_asset' => new ImageAsset(['data' => $imageContent])
]);
// Creates an asset operation.
$assetOperation = new AssetOperation();
$assetOperation->setCreate($asset);
// Issues a mutate request to add the asset.
$assetServiceClient = $googleAdsClient->getAssetServiceClient();
$response = $assetServiceClient->mutateAssets(MutateAssetsRequest::build(
$customerId,
[$assetOperation]
));
if (!empty($response->getResults())) {
// Prints the resource name of the added image asset.
/** @var MutateAssetResult $addedImageAsset */
$addedImageAsset = $response->getResults()[0];
printf(
"The image asset with resource name '%s' was created.%s",
$addedImageAsset->getResourceName(),
PHP_EOL
);
} else {
print 'No image asset was created.' . PHP_EOL;
}
}
}
UploadImageAsset::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 asset.
To get image assets, run get_all_image_assets.py.
"""
import
argparse
import
sys
from
examples.utils.example_helpers
import
get_image_bytes_from_url
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.v21.resources.types.asset
import
Asset
from
google.ads.googleads.v21.services.services.asset_service.client
import
(
AssetServiceClient
,
)
from
google.ads.googleads.v21.services.types.asset_service
import
(
AssetOperation
,
MutateAssetResult
,
MutateAssetsResponse
,
)
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
)
-
> None
:
"""Main method, to run this code example as a standalone application."""
# Download image from URL
url
:
str
=
"https://gaagl.page.link/Eit5"
image_content
:
bytes
=
get_image_bytes_from_url
(
url
)
asset_service
:
AssetServiceClient
=
client
.
get_service
(
"AssetService"
)
asset_operation
:
AssetOperation
=
client
.
get_type
(
"AssetOperation"
)
asset
:
Asset
=
asset_operation
.
create
asset
.
type_
=
client
.
enums
.
AssetTypeEnum
.
IMAGE
asset
.
image_asset
.
data
=
image_content
asset
.
image_asset
.
file_size
=
len
(
image_content
)
asset
.
image_asset
.
mime_type
=
client
.
enums
.
MimeTypeEnum
.
IMAGE_JPEG
# Use your favorite image library to determine dimensions
asset
.
image_asset
.
full_size
.
height_pixels
=
315
asset
.
image_asset
.
full_size
.
width_pixels
=
600
asset
.
image_asset
.
full_size
.
url
=
url
# Provide a unique friendly name to identify your asset.
# When there is an existing image asset with the same content but a different
# name, the new name will be dropped silently.
asset
.
name
=
"Marketing Image"
mutate_asset_response
:
MutateAssetsResponse
=
asset_service
.
mutate_assets
(
customer_id
=
customer_id
,
operations
=
[
asset_operation
]
)
print
(
"Uploaded file(s):"
)
row
:
MutateAssetResult
for
row
in
mutate_asset_response
.
results
:
print
(
f
"
\t
Resource name:
{
row
.
resource_name
}
"
)
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
"Upload an image asset 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
()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client
=
GoogleAdsClient
.
load_from_storage
(
version
=
"v21"
)
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
'
\t
Error with message "
{
error
.
message
}
".'
)
if
error
.
location
:
for
field_path_element
in
error
.
location
.
field_path_elements
:
print
(
f
"
\t\t
On 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 uploads an image asset.
# To get image assets, run get_all_image_assets.rb.
require
'optparse'
require
'google/ads/google_ads'
require
'open-uri'
def
upload_image_asset
(
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
url
=
'https://gaagl.page.link/Eit5'
image_data
=
open
(
url
)
{
|
f
|
f
.
read
}
# Create the operation for uploading the image asset.
asset_operation
=
client
.
operation
.
create_resource
.
asset
do
|
asset
|
asset
.
type
=
:IMAGE
asset
.
image_asset
=
client
.
resource
.
image_asset
do
|
image_asset
|
image_asset
.
data
=
image_data
image_asset
.
file_size
=
image_data
.
length
()
image_asset
.
mime_type
=
:IMAGE_JPEG
image_asset
.
full_size
=
client
.
resource
.
image_dimension
do
|
dimension
|
dimension
.
height_pixels
=
315
dimension
.
width_pixels
=
600
dimension
.
url
=
url
end
end
# Provide a unique friendly name to identify your asset.
# When there is an existing image asset with the same content but a different
# name, the new name will be dropped silently.
asset
.
name
=
"Marketing Image"
end
# Upload the image asset.
response
=
client
.
service
.
asset
.
mutate_assets
(
customer_id
:
customer_id
,
operations
:
[
asset_operation
]
,
)
puts
"Uploaded image asset
#{
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_asset
(
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
(
'
\t
On 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
(
'
\t
Type: %s
\n\t
Code: %s
\n
'
,
k
,
v
)
end
end
raise
end
end
Perl
#!/usr/bin/perl -w
#
# 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.
#
# This example uploads an image asset. To get image assets, run get_all_image_assets.pl.
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::V21::Resources::Asset
;
use
Google::Ads::GoogleAds::V21::Common::ImageAsset
;
use
Google::Ads::GoogleAds::V21::Enums::AssetTypeEnum
qw(IMAGE)
;
use
Google::Ads::GoogleAds::V21::Services::AssetService::AssetOperation
;
use
Getopt::Long
qw(:config auto_help)
;
use
Pod::Usage
;
use
Cwd
qw(abs_path)
;
use
Data::Uniqid
qw(uniqid)
;
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_asset
{
my
(
$api_client
,
$customer_id
)
=
@_
;
# Create an image content.
my
$image_content
=
get_base64_data_from_url
(
IMAGE_URL
);
# Create an asset.
my
$asset
=
Google::Ads::GoogleAds::V21::Resources::
Asset
-
> new
({
# Provide a unique friendly name to identify your asset.
# When there is an existing image asset with the same content but a different
# name, the new name will be dropped silently.
name
=
>
"Marketing Image"
,
type
=
>
IMAGE
,
imageAsset
=
>
Google::Ads::GoogleAds::V21::Common::
ImageAsset
-
> new
({
data
=
>
$image_content
})});
# Create an asset operation.
my
$asset_operation
=
Google::Ads::GoogleAds::V21::Services::AssetService::
AssetOperation
-
> new
({
create
=
>
$asset
});
# Issue a mutate request to add the asset.
my
$assets_response
=
$api_client
-
> AssetService
()
-
> mutate
({
customerId
=
>
$customer_id
,
operations
=
>
[
$asset_operation
]});
printf
"The image asset with resource name '%s' was created.\n"
,
$assets_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_asset
(
$api_client
,
$customer_id
=~
s/-//g
r
);
=pod
=head1 NAME
upload_image_asset
=head1 DESCRIPTION
This example uploads an image asset. To get image assets, run get_all_image_assets.pl.
=head1 SYNOPSIS
upload_image_asset.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
=cut
curl
#
Copyright
2025
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. #
Creates
an
image
asset. #
#
Variables: #
API_VERSION, #
CUSTOMER_ID, #
DEVELOPER_TOKEN, #
MANAGER_CUSTOMER_ID, #
OAUTH2_ACCESS_TOKEN: #
See
https://developers.google.com/google-ads/api/rest/auth#request_headers #
for
details. #
#
IMAGE_CONTENT:
A
base64-encoded
string
of
the
raw
bytes
data
of
an
image. #
IMAGE_MIME_TYPE:
The
MIME
type
of
the
image,
for
example,
IMAGE_JPEG. #
IMAGE_FILE_SIZE:
The
file
size
of
the
image
in
bytes,
for
example,
1000000
. #
IMAGE_HEIGHT:
The
height
of
the
image,
for
example,
100
. #
IMAGE_WIDTH:
The
width
of
the
image,
for
example,
200
. #
IMAGE_URL:
The
URL
of
the
image. curl -f --request POST \
"https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}/assets:mutate" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data @- <<EOF
{
"operations": [
{
"create": {
"imageAsset": {
"data": "${IMAGE_CONTENT}",
"fileSize": "${IMAGE_FILE_SIZE}",
"mimeType": "${IMAGE_MIME_TYPE}",
"fullSize": {
"heightPixels": "${IMAGE_HEIGHT}",
"widthPixels": "${IMAGE_WIDTH}",
"url": "${IMAGE_URL}"
}
},
"name": "Marketing Image"
}
}
]
}
EOF
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThe code snippets demonstrate uploading an image asset to a Google Ads account using the Google Ads API across various programming languages (Java, C#, PHP, Python, Ruby, Perl).\u003c/p\u003e\n"],["\u003cp\u003eThe process involves initializing a client, retrieving the image from a URL, creating an asset object with image data, and uploading it using the respective API service.\u003c/p\u003e\n"],["\u003cp\u003eError handling is implemented to catch potential exceptions during the upload process and provide debugging information.\u003c/p\u003e\n"],["\u003cp\u003eWhile the core functionality is consistent, language-specific syntax and code structure vary slightly between the examples.\u003c/p\u003e\n"],["\u003cp\u003eA unique friendly name ("Marketing Image") is assigned to the asset, and the image is sourced from a common URL ("https://gaagl.page.link/Eit5") as a JPEG.\u003c/p\u003e\n"]]],[],null,[]]
