/
ApproveMerchantCenterLink.php
206 lines (191 loc) · 8.58 KB
/
ApproveMerchantCenterLink.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?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\AccountManagement;
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\V6\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsException;
use Google\Ads\GoogleAds\Util\FieldMasks;
use Google\Ads\GoogleAds\V6\Enums\MerchantCenterLinkStatusEnum\MerchantCenterLinkStatus;
use Google\Ads\GoogleAds\V6\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V6\Resources\MerchantCenterLink;
use Google\Ads\GoogleAds\V6\Services\MerchantCenterLinkOperation;
use Google\Ads\GoogleAds\V6\Services\MerchantCenterLinkServiceClient;
use Google\ApiCore\ApiException;
/**
* Demonstrates how to approve a Merchant Center link request.
*
* <p>Prerequisite: You need to have access to a Merchant Center account. You can find instructions
* to create a Merchant Center account here: https://support.google.com/merchants/answer/188924.
*
* <p>To run this example, you must use the Merchant Center UI or the Content API for Shopping to
* send a link request between your Merchant Center and Google Ads accounts.
* See https://support.google.com/merchants/answer/6159060 for details.
*/
class ApproveMerchantCenterLink
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const MERCHANT_CENTER_ACCOUNT_ID = 'INSERT_MERCHANT_CENTER_ACCOUNT_ID_HERE';
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,
ArgumentNames::MERCHANT_CENTER_ACCOUNT_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,
$options[ArgumentNames::MERCHANT_CENTER_ACCOUNT_ID] ?: self::MERCHANT_CENTER_ACCOUNT_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
* @param int $merchantCenterAccountId the Merchant Center account ID
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $merchantCenterAccountId
) {
// [START approve_merchant_center_link]
// Lists all merchant links of the specified customer ID.
$merchantCenterLinkServiceClient = $googleAdsClient->getMerchantCenterLinkServiceClient();
$response = $merchantCenterLinkServiceClient->listMerchantCenterLinks($customerId);
printf(
"%d Merchant Center link(s) found with the following details:%s",
$response->getMerchantCenterLinks()->count(),
PHP_EOL
);
// [END approve_merchant_center_link]
foreach ($response->getMerchantCenterLinks() as $merchantCenterLink) {
/** @var MerchantCenterLink $merchantCenterLink */
// [START approve_merchant_center_link_1]
printf(
"Link '%s' has status '%s'.%s",
$merchantCenterLink->getResourceName(),
MerchantCenterLinkStatus::name($merchantCenterLink->getStatus()),
PHP_EOL
);
// [END approve_merchant_center_link_1]
// Approves a pending link request for a Google Ads account with the specified customer
// ID from a Merchant Center account with the specified Merchant Center account ID.
if (
$merchantCenterLink->getId() === $merchantCenterAccountId
&& $merchantCenterLink->getStatus() === MerchantCenterLinkStatus::PENDING
) {
// Updates the status of Merchant Center link to 'ENABLED' to approve the link.
self::updateMerchantCenterLinkStatus(
$merchantCenterLinkServiceClient,
$customerId,
$merchantCenterLink,
MerchantCenterLinkStatus::ENABLED
);
// There is only one MerchantCenterLink object for a given Google Ads account and
// Merchant Center account, so we can break early.
break;
}
}
}
/**
* Updates the status of a Merchant Center link with a specified Merchant Center link status.
*
* @param MerchantCenterLinkServiceClient $merchantCenterLinkServiceClient the Merchant Center
* link service client
* @param int $customerId the customer ID
* @param MerchantCenterLink $merchantCenterLink the Merchant Center link to update
* @param int $newMerchantCenterLinkStatus the status to be updated to
*/
// [START approve_merchant_center_link_2]
private static function updateMerchantCenterLinkStatus(
MerchantCenterLinkServiceClient $merchantCenterLinkServiceClient,
int $customerId,
MerchantCenterLink $merchantCenterLink,
int $newMerchantCenterLinkStatus
) {
// Creates an updated MerchantCenterLink object derived from the original, but with the
// specified status.
$merchantCenterLinkToUpdate = new MerchantCenterLink([
'resource_name' => $merchantCenterLink->getResourceName(),
'status' => $newMerchantCenterLinkStatus
]);
// Constructs an operation that will update the Merchant Center link,
// using the FieldMasks utility to derive the update mask. This mask tells the
// Google Ads API which attributes of the Merchant Center link you want to change.
$merchantCenterLinkOperation = new MerchantCenterLinkOperation();
$merchantCenterLinkOperation->setUpdate($merchantCenterLinkToUpdate);
$merchantCenterLinkOperation->setUpdateMask(
FieldMasks::allSetFieldsOf($merchantCenterLinkToUpdate)
);
// Issues a mutate request to update the Merchant Center link and prints some
// information.
$response = $merchantCenterLinkServiceClient->mutateMerchantCenterLink(
$customerId,
$merchantCenterLinkOperation
);
printf(
"Approved a Merchant Center Link with resource name '%s' to the Google Ads "
. "account '%s'.%s",
$response->getResult()->getResourceName(),
$customerId,
PHP_EOL
);
}
// [END approve_merchant_center_link_2]
}
ApproveMerchantCenterLink::main();