Skip to content

Commit 7f71eae

Browse files
eric-urbaneric-urban
authored
Merge pull request #82 from BingAds/v11-12-7
Update proxies and sample helpers
2 parents 5d851d1 + a08669e commit 7f71eae

16 files changed

+166
-23
lines changed

‎samples/V12/AdExtensions.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,10 @@
9797
$campaigns[] = $campaign;
9898

9999
print "AddCampaigns\n";
100-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
100+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
101+
$GLOBALS['AuthorizationData']->AccountId,
102+
$campaigns,
103+
false);
101104
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
102105
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
103106
if(isset($addCampaignsResponse->PartialErrors->BatchError)){

‎samples/V12/AudienceCampaigns.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@
185185
print "AddCampaigns\n";
186186
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
187187
$GLOBALS['AuthorizationData']->AccountId,
188-
$campaigns);
188+
$campaigns,
189+
false);
189190
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
190191
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
191192
if(isset($addCampaignsResponse->PartialErrors->BatchError)){

‎samples/V12/CampaignManagementExampleHelper.php‎

Lines changed: 63 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,8 @@ static function AddCampaignCriterions(
206206
}
207207
static function AddCampaigns(
208208
$accountId,
209-
$campaigns)
209+
$campaigns,
210+
$includeDynamicSearchAdsSource)
210211
{
211212
$GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
212213
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -215,6 +216,7 @@ static function AddCampaigns(
215216

216217
$request->AccountId = $accountId;
217218
$request->Campaigns = $campaigns;
219+
$request->IncludeDynamicSearchAdsSource = $includeDynamicSearchAdsSource;
218220

219221
return $GLOBALS['CampaignManagementProxy']->GetService()->AddCampaigns($request);
220222
}
@@ -732,7 +734,8 @@ static function GetAdGroupsByIds(
732734
}
733735
static function GetAdsByAdGroupId(
734736
$adGroupId,
735-
$adTypes)
737+
$adTypes,
738+
$returnAdditionalFields)
736739
{
737740
$GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
738741
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -741,13 +744,15 @@ static function GetAdsByAdGroupId(
741744

742745
$request->AdGroupId = $adGroupId;
743746
$request->AdTypes = $adTypes;
747+
$request->ReturnAdditionalFields = $returnAdditionalFields;
744748

745749
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByAdGroupId($request);
746750
}
747751
static function GetAdsByEditorialStatus(
748752
$adGroupId,
749753
$editorialStatus,
750-
$adTypes)
754+
$adTypes,
755+
$returnAdditionalFields)
751756
{
752757
$GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
753758
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -757,13 +762,15 @@ static function GetAdsByEditorialStatus(
757762
$request->AdGroupId = $adGroupId;
758763
$request->EditorialStatus = $editorialStatus;
759764
$request->AdTypes = $adTypes;
765+
$request->ReturnAdditionalFields = $returnAdditionalFields;
760766

761767
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByEditorialStatus($request);
762768
}
763769
static function GetAdsByIds(
764770
$adGroupId,
765771
$adIds,
766-
$adTypes)
772+
$adTypes,
773+
$returnAdditionalFields)
767774
{
768775
$GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
769776
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -773,6 +780,7 @@ static function GetAdsByIds(
773780
$request->AdGroupId = $adGroupId;
774781
$request->AdIds = $adIds;
775782
$request->AdTypes = $adTypes;
783+
$request->ReturnAdditionalFields = $returnAdditionalFields;
776784

777785
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByIds($request);
778786
}
@@ -1368,7 +1376,8 @@ static function UpdateCampaignCriterions(
13681376
}
13691377
static function UpdateCampaigns(
13701378
$accountId,
1371-
$campaigns)
1379+
$campaigns,
1380+
$includeDynamicSearchAdsSource)
13721381
{
13731382
$GLOBALS['CampaignManagementProxy']->SetAuthorizationData($GLOBALS['AuthorizationData']);
13741383
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
@@ -1377,6 +1386,7 @@ static function UpdateCampaigns(
13771386

13781387
$request->AccountId = $accountId;
13791388
$request->Campaigns = $campaigns;
1389+
$request->IncludeDynamicSearchAdsSource = $includeDynamicSearchAdsSource;
13801390

13811391
return $GLOBALS['CampaignManagementProxy']->GetService()->UpdateCampaigns($request);
13821392
}
@@ -3347,8 +3357,10 @@ static function OutputExpandedTextAd($dataObject)
33473357
self::OutputStatusMessage(sprintf("Path1: %s", $dataObject->Path1));
33483358
self::OutputStatusMessage(sprintf("Path2: %s", $dataObject->Path2));
33493359
self::OutputStatusMessage(sprintf("Text: %s", $dataObject->Text));
3360+
self::OutputStatusMessage(sprintf("TextPart2: %s", $dataObject->TextPart2));
33503361
self::OutputStatusMessage(sprintf("TitlePart1: %s", $dataObject->TitlePart1));
33513362
self::OutputStatusMessage(sprintf("TitlePart2: %s", $dataObject->TitlePart2));
3363+
self::OutputStatusMessage(sprintf("TitlePart3: %s", $dataObject->TitlePart3));
33523364
}
33533365
self::OutputStatusMessage("* * * End OutputExpandedTextAd * * *");
33543366
}
@@ -5228,6 +5240,29 @@ static function OutputArrayOfCallToAction($valueSets)
52285240
}
52295241
self::OutputStatusMessage("* * * End OutputArrayOfCallToAction * * *");
52305242
}
5243+
static function OutputAssetLinkEditorialStatus($valueSet)
5244+
{
5245+
self::OutputStatusMessage("* * * Begin OutputAssetLinkEditorialStatus * * *");
5246+
self::OutputStatusMessage(sprintf("Values in %s", $valueSet->type));
5247+
foreach ($valueSet->string as $value)
5248+
{
5249+
self::OutputStatusMessage($value);
5250+
}
5251+
self::OutputStatusMessage("* * * End OutputAssetLinkEditorialStatus * * *");
5252+
}
5253+
static function OutputArrayOfAssetLinkEditorialStatus($valueSets)
5254+
{
5255+
if(count((array)$valueSets) == 0)
5256+
{
5257+
return;
5258+
}
5259+
self::OutputStatusMessage("* * * Begin OutputArrayOfAssetLinkEditorialStatus * * *");
5260+
foreach ($valueSets->AssetLinkEditorialStatus as $valueSet)
5261+
{
5262+
self::OutputAssetLinkEditorialStatus($valueSet);
5263+
}
5264+
self::OutputStatusMessage("* * * End OutputArrayOfAssetLinkEditorialStatus * * *");
5265+
}
52315266
static function OutputBudgetLimitType($valueSet)
52325267
{
52335268
self::OutputStatusMessage("* * * Begin OutputBudgetLimitType * * *");
@@ -5458,6 +5493,29 @@ static function OutputArrayOfAdGroupStatus($valueSets)
54585493
}
54595494
self::OutputStatusMessage("* * * End OutputArrayOfAdGroupStatus * * *");
54605495
}
5496+
static function OutputAdAdditionalField($valueSet)
5497+
{
5498+
self::OutputStatusMessage("* * * Begin OutputAdAdditionalField * * *");
5499+
self::OutputStatusMessage(sprintf("Values in %s", $valueSet->type));
5500+
foreach ($valueSet->string as $value)
5501+
{
5502+
self::OutputStatusMessage($value);
5503+
}
5504+
self::OutputStatusMessage("* * * End OutputAdAdditionalField * * *");
5505+
}
5506+
static function OutputArrayOfAdAdditionalField($valueSets)
5507+
{
5508+
if(count((array)$valueSets) == 0)
5509+
{
5510+
return;
5511+
}
5512+
self::OutputStatusMessage("* * * Begin OutputArrayOfAdAdditionalField * * *");
5513+
foreach ($valueSets->AdAdditionalField as $valueSet)
5514+
{
5515+
self::OutputAdAdditionalField($valueSet);
5516+
}
5517+
self::OutputStatusMessage("* * * End OutputArrayOfAdAdditionalField * * *");
5518+
}
54615519
static function OutputKeywordEditorialStatus($valueSet)
54625520
{
54635521
self::OutputStatusMessage("* * * Begin OutputKeywordEditorialStatus * * *");

‎samples/V12/DynamicSearchAds.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,10 @@
109109
$campaigns[] = $campaign;
110110

111111
print "AddCampaigns\n";
112-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
112+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
113+
$GLOBALS['AuthorizationData']->AccountId,
114+
$campaigns,
115+
false);
113116
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
114117
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
115118
if(isset($addCampaignsResponse->PartialErrors)){

‎samples/V12/KeywordsAds.php‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
use Microsoft\BingAds\V12\CampaignManagement\Keyword;
2424
use Microsoft\BingAds\V12\CampaignManagement\Ad;
2525
use Microsoft\BingAds\V12\CampaignManagement\AdType;
26+
use Microsoft\BingAds\V12\CampaignManagement\AdAdditionalField;
2627
use Microsoft\BingAds\V12\CampaignManagement\ExpandedTextAd;
2728
use Microsoft\BingAds\V12\CampaignManagement\Bid;
2829
use Microsoft\BingAds\V12\CampaignManagement\BiddingScheme;
@@ -262,7 +263,10 @@
262263
// Add the campaign, ad group, keywords, and ads
263264

264265
print "AddCampaigns\n";
265-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
266+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
267+
$GLOBALS['AuthorizationData']->AccountId,
268+
$campaigns,
269+
false);
266270
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
267271
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
268272
if(isset($addCampaignsResponse->PartialErrors->BatchError)){
@@ -412,7 +416,10 @@
412416
$index++;
413417
}
414418

415-
CampaignManagementExampleHelper::UpdateCampaigns($GLOBALS['AuthorizationData']->AccountId, $updateCampaigns);
419+
CampaignManagementExampleHelper::UpdateCampaigns(
420+
$GLOBALS['AuthorizationData']->AccountId,
421+
$updateCampaigns,
422+
false);
416423

417424
$getCampaigns = CampaignManagementExampleHelper::GetCampaignsByIds(
418425
$GLOBALS['AuthorizationData']->AccountId,
@@ -465,12 +472,23 @@
465472
// As an exercise you can view the results before and after update.
466473

467474
$adTypes = array(AdType::AppInstall, AdType::DynamicSearch, AdType::ExpandedText, AdType::Product, AdType::Text);
468-
$ads = CampaignManagementExampleHelper::GetAdsByAdGroupId($nillableAdGroupIds->long[0], $adTypes);
469-
CampaignManagementExampleHelper::OutputArrayOfAd($ads);
475+
$adAdditionalFields = array(AdAdditionalField::TextPart2, AdAdditionalField::TitlePart3);
476+
$ads = CampaignManagementExampleHelper::GetAdsByAdGroupId(
477+
$nillableAdGroupIds->long[0],
478+
$adTypes,
479+
$adAdditionalFields);
480+
if(isset($ads->Ads)){
481+
CampaignManagementExampleHelper::OutputArrayOfAd($ads->Ads);
482+
}
470483

471484
$updateAdsResponse = CampaignManagementExampleHelper::UpdateAds($nillableAdGroupIds->long[0], $updateAds);
472-
$ads = CampaignManagementExampleHelper::GetAdsByAdGroupId($nillableAdGroupIds->long[0], $adTypes);
473-
CampaignManagementExampleHelper::OutputArrayOfAd($ads);
485+
$ads = CampaignManagementExampleHelper::GetAdsByAdGroupId(
486+
$nillableAdGroupIds->long[0],
487+
$adTypes,
488+
$adAdditionalFields);
489+
if(isset($ads->Ads)){
490+
CampaignManagementExampleHelper::OutputArrayOfAd($ads->Ads);
491+
}
474492

475493
// Here is a simple example that updates the keyword bid to use the ad group bid
476494

@@ -485,15 +503,19 @@
485503
// As an exercise you can view the results before and after update.
486504

487505
$keywords = CampaignManagementExampleHelper::GetKeywordsByAdGroupId($nillableAdGroupIds->long[0], null);
488-
CampaignManagementExampleHelper::OutputArrayOfKeyword($keywords);
506+
if(isset($keywords->Keywords)){
507+
CampaignManagementExampleHelper::OutputArrayOfKeyword($keywords->Keywords);
508+
}
489509

490510
$updateKeywordsResponse = CampaignManagementExampleHelper::UpdateKeywords(
491511
$nillableAdGroupIds->long[0],
492512
$updateKeywords,
493513
null);
494514
$keywords = CampaignManagementExampleHelper::GetKeywordsByAdGroupId($nillableAdGroupIds->long[0], null);
495-
CampaignManagementExampleHelper::OutputArrayOfKeyword($keywords);
496-
515+
if(isset($keywords->Keywords)){
516+
CampaignManagementExampleHelper::OutputArrayOfKeyword($keywords->Keywords);
517+
}
518+
497519
// As an exercise you can delete the keyword
498520
CampaignManagementExampleHelper::DeleteKeywords($nillableAdGroupIds->long[0], array($nillableKeywordIds->long[1]));
499521

‎samples/V12/Labels.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@
138138

139139
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
140140
$GLOBALS['AuthorizationData']->AccountId,
141-
$campaigns);
141+
$campaigns,
142+
false);
142143
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
143144
$campaignErrors = $addLabelsResponse->PartialErrors;
144145
print("New Campaign Ids:\n");

‎samples/V12/NegativeKeywords.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,10 @@
6868
$campaigns[] = $campaign;
6969

7070
print "AddCampaigns\n";
71-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
71+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
72+
$GLOBALS['AuthorizationData']->AccountId,
73+
$campaigns,
74+
false);
7275
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
7376
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
7477
if(isset($addCampaignsResponse->PartialErrors->BatchError)){

‎samples/V12/RemarketingLists.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,10 @@
132132
$adGroups[] = $adGroup;
133133

134134
print "AddCampaigns\n";
135-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
135+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
136+
$GLOBALS['AuthorizationData']->AccountId,
137+
$campaigns,
138+
false);
136139
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
137140
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
138141
if(isset($addCampaignsResponse->PartialErrors->BatchError)){

‎samples/V12/ShoppingCampaigns.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,10 @@
140140
$ads[] = $encodedAd;
141141

142142
print "AddCampaigns\n";
143-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
143+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
144+
$GLOBALS['AuthorizationData']->AccountId,
145+
$campaigns,
146+
false);
144147
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
145148
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
146149
if(isset($addCampaignsResponse->PartialErrors->BatchError)){

‎samples/V12/TargetCriterions.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,10 @@ function GetExampleCampaignIds()
304304
}
305305

306306
print "AddCampaigns\n";
307-
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns($GLOBALS['AuthorizationData']->AccountId, $campaigns);
307+
$addCampaignsResponse = CampaignManagementExampleHelper::AddCampaigns(
308+
$GLOBALS['AuthorizationData']->AccountId,
309+
$campaigns,
310+
false);
308311
$nillableCampaignIds = $addCampaignsResponse->CampaignIds;
309312
CampaignManagementExampleHelper::OutputArrayOfLong($nillableCampaignIds);
310313
if(isset($addCampaignsResponse->PartialErrors->BatchError)){

0 commit comments

Comments
 (0)