/
AddGmailAd.php
executable file
·151 lines (132 loc) · 5.44 KB
/
AddGmailAd.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?php
/**
* Copyright 2018 Google Inc. All Rights Reserved.
*
* 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.
*/
namespace Google\AdsApi\Examples\AdWords\v201809\AdvancedOperations;
require __DIR__ . '/../../../../vendor/autoload.php';
use Google\AdsApi\AdWords\AdWordsServices;
use Google\AdsApi\AdWords\AdWordsSession;
use Google\AdsApi\AdWords\AdWordsSessionBuilder;
use Google\AdsApi\AdWords\v201809\cm\AdGroupAd;
use Google\AdsApi\AdWords\v201809\cm\AdGroupAdOperation;
use Google\AdsApi\AdWords\v201809\cm\AdGroupAdService;
use Google\AdsApi\AdWords\v201809\cm\AdGroupAdStatus;
use Google\AdsApi\AdWords\v201809\cm\GmailAd;
use Google\AdsApi\AdWords\v201809\cm\GmailTeaser;
use Google\AdsApi\AdWords\v201809\cm\Image;
use Google\AdsApi\AdWords\v201809\cm\MediaMediaType;
use Google\AdsApi\AdWords\v201809\cm\MediaService;
use Google\AdsApi\AdWords\v201809\cm\Operator;
use Google\AdsApi\Common\OAuth2TokenBuilder;
/**
* This code example adds a Gmail ad to a given ad group. The ad group's
* campaign needs to have an AdvertisingChannelType of DISPLAY and
* AdvertisingChannelSubType of DISPLAY_GMAIL_AD.
* To get ad groups, run BasicOperations/GetAdGroups.php.
*/
class AddGmailAd
{
const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE';
public static function runExample(
AdWordsServices $adWordsServices,
AdWordsSession $session,
$adGroupId
) {
$mediaService =
$adWordsServices->get($session, MediaService::class);
$adGroupAdService =
$adWordsServices->get($session, AdGroupAdService::class);
// This ad format does not allow the creation of an image using the
// Image.data field. An image must first be created using the
// MediaService, and Image.mediaId must be populated when creating the
// ad.
$uploadedLogoImage =
self::uploadImage($mediaService, 'https://goo.gl/mtt54n');
$logoImage = new Image();
$logoImage->setMediaId($uploadedLogoImage->getMediaId());
$uploadedMarketingImage =
self::uploadImage($mediaService, 'http://goo.gl/3b9Wfh');
$marketingImage = new Image();
$marketingImage->setMediaId($uploadedMarketingImage->getMediaId());
$teaser = new GmailTeaser();
$teaser->setHeadline('Dream');
$teaser->setDescription('Create your own adventure');
$teaser->setBusinessName('Interplanetary Ships');
$teaser->setLogoImage($logoImage);
// Creates a Gmail ad.
$gmailAd = new GmailAd();
$gmailAd->setTeaser($teaser);
$gmailAd->setMarketingImage($marketingImage);
$gmailAd->setMarketingImageHeadline('Travel');
$gmailAd->setMarketingImageDescription('Take to the skies!');
$gmailAd->setFinalUrls(['http://www.example.com/']);
// Creates ad group ad for the Gmail ad.
$adGroupAd = new AdGroupAd();
$adGroupAd->setAdGroupId($adGroupId);
$adGroupAd->setAd($gmailAd);
// Optional: Set additional settings.
$adGroupAd->setStatus(AdGroupAdStatus::PAUSED);
// Creates ad group ad operation and add it to the list.
$operation = new AdGroupAdOperation();
$operation->setOperand($adGroupAd);
$operation->setOperator(Operator::ADD);
// Adds a Gmail ad on the server.
$result = $adGroupAdService->mutate([$operation]);
if (empty($result->getValue())) {
print "No Gmail ads were added.\n";
return;
}
// Prints out some information for each created Gmail ad.
foreach ($result->getValue() as $adGroupAd) {
printf(
"A Gmail ad with ID %d and headline '%s' was added.\n",
$adGroupAd->getAd()->getId(),
$adGroupAd->getAd()->getTeaser()->getHeadline()
);
}
}
/**
* Uploads an image to the server.
*
* @param MediaService $mediaService the media service
* @param string $url the URL of image to upload
* @return Image the uploaded image returned from the server
*/
private static function uploadImage(MediaService $mediaService, $url)
{
// Creates an image and upload it to the server.
$image = new Image();
$image->setData(file_get_contents($url));
$image->setType(MediaMediaType::IMAGE);
return $mediaService->upload([$image])[0];
}
public static function main()
{
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct an API session configured from a properties file and the
// OAuth2 credentials above.
$session = (new AdWordsSessionBuilder())
->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
self::runExample(
new AdWordsServices(),
$session,
intval(self::AD_GROUP_ID)
);
}
}
AddGmailAd::main();