Search in sources :

Example 1 with OfflineDataUploadType

use of com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadType in project googleads-java-lib by googleads.

the class UploadOfflineData method main.

public static void main(String[] args) {
    AdWordsSession session;
    try {
        // Generate a refreshable OAuth2 credential.
        Credential oAuth2Credential = new OfflineCredentials.Builder().forApi(Api.ADWORDS).fromFile().build().generateCredential();
        // Construct an AdWordsSession.
        session = new AdWordsSession.Builder().fromFile().withOAuth2Credential(oAuth2Credential).build();
    } catch (ConfigurationLoadException cle) {
        System.err.printf("Failed to load configuration from the %s file. Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, cle);
        return;
    } catch (ValidationException ve) {
        System.err.printf("Invalid configuration in the %s file. Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, ve);
        return;
    } catch (OAuthException oe) {
        System.err.printf("Failed to create OAuth credentials. Check OAuth settings in the %s file. " + "Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, oe);
        return;
    }
    AdWordsServicesInterface adWordsServices = AdWordsServices.getInstance();
    UploadOfflineDataParams params = new UploadOfflineDataParams();
    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.emailAddresses = Arrays.asList("INSERT_EMAIL_ADDRESS_1_HERE", "INSERT_EMAIL_ADDRESS_2_HERE");
        params.conversionName = "INSERT_CONVERSION_NAME_HERE";
        params.externalUploadId = Long.valueOf("INSERT_EXTERNAL_UPLOAD_ID_HERE");
        // Change the enum below to STORE_SALES_UPLOAD_THIRD_PARTY if uploading third party data.
        params.offlineDataUploadType = OfflineDataUploadType.STORE_SALES_UPLOAD_FIRST_PARTY.getValue();
        // The three constants below are needed when uploading third party data.
        // You can safely ignore them if you are uploading first party data.
        // For times, use the format yyyyMMdd HHmmss tz. For more details on formats, see:
        // https://developers.google.com/adwords/api/docs/appendix/codes-formats#date-and-time-formats
        // For time zones, see:
        // https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids
        params.advertiserUploadTime = "INSERT_ADVERTISER_UPLOAD_TIME";
        params.bridgeMapVersionId = "INSERT_BRIDGE_MAP_VERSION_ID";
        params.partnerId = Integer.valueOf("INSERT_PARTNER_ID");
    }
    OfflineDataUploadType uploadTypeEnum = OfflineDataUploadType.fromString(params.offlineDataUploadType);
    // Set partial failure to true since this example demonstrates how to handle partial
    // failure errors.
    session.setPartialFailure(true);
    try {
        runExample(adWordsServices, session, params.conversionName, params.externalUploadId, params.emailAddresses, uploadTypeEnum, params.advertiserUploadTime, params.bridgeMapVersionId, params.partnerId);
    } catch (ApiException apiException) {
        // ApiException is the base class for most exceptions thrown by an API request. Instances
        // of this exception have a message and a collection of ApiErrors that indicate the
        // type and underlying cause of the exception. Every exception object in the adwords.axis
        // packages will return a meaningful value from toString
        // 
        // ApiException extends RemoteException, so this catch block must appear before the
        // catch block for RemoteException.
        System.err.println("Request failed due to ApiException. Underlying ApiErrors:");
        if (apiException.getErrors() != null) {
            int i = 0;
            for (ApiError apiError : apiException.getErrors()) {
                System.err.printf("  Error %d: %s%n", i++, apiError);
            }
        }
    } catch (RemoteException re) {
        System.err.printf("Request failed unexpectedly due to RemoteException: %s%n", re);
    } catch (UnsupportedEncodingException ue) {
        System.err.printf("Example failed due to encoding exception: %s%n", ue);
    }
}
Also used : Credential(com.google.api.client.auth.oauth2.Credential) ValidationException(com.google.api.ads.common.lib.exception.ValidationException) OAuthException(com.google.api.ads.common.lib.exception.OAuthException) AdWordsServicesInterface(com.google.api.ads.adwords.lib.factory.AdWordsServicesInterface) UnsupportedEncodingException(java.io.UnsupportedEncodingException) AdWordsSession(com.google.api.ads.adwords.lib.client.AdWordsSession) ConfigurationLoadException(com.google.api.ads.common.lib.conf.ConfigurationLoadException) OfflineDataUploadType(com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadType) ApiError(com.google.api.ads.adwords.axis.v201809.cm.ApiError) RemoteException(java.rmi.RemoteException) ApiException(com.google.api.ads.adwords.axis.v201809.cm.ApiException)

Example 2 with OfflineDataUploadType

use of com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadType in project googleads-java-lib by googleads.

the class UploadOfflineData method runExample.

/**
 * Runs the example.
 *
 * @param adWordsServices the services factory.
 * @param session the session.
 * @param conversionName the name of the conversion tracker.
 * @param externalUploadId the external upload ID.
 * @param emailAddresses the list of email addresses. Must contain exactly two entries for this
 *     example.
 * @param offlineDataUploadType the type of store sales upload metadata to upload.
 * @param advertiserUploadTime the date and time of the advertiser upload.
 * @param bridgeMapVersionId the bridge map version ID.
 * @param partnerId the partner ID.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws UnsupportedEncodingException if encoding the offline data values failed.
 */
public static void runExample(AdWordsServicesInterface adWordsServices, AdWordsSession session, String conversionName, long externalUploadId, List<String> emailAddresses, OfflineDataUploadType offlineDataUploadType, String advertiserUploadTime, String bridgeMapVersionId, Integer partnerId) throws RemoteException, UnsupportedEncodingException {
    // This example requires exactly 2 email addresses.
    if (emailAddresses.size() != 2) {
        throw new IllegalArgumentException(String.format("%d email addresses specified. Please specify exactly 2 email addresses.", emailAddresses.size()));
    }
    // Get the OfflineDataUploadService.
    OfflineDataUploadServiceInterface offlineDataUploadService = adWordsServices.get(session, OfflineDataUploadServiceInterface.class);
    List<OfflineData> offlineDataList = new ArrayList<>();
    // Create the first offline data for upload.
    // This transaction occurred 7 days ago with amount of 200 USD.
    DateTime transactionTime1 = DateTime.now().minusDays(7);
    long transactionAmount1 = 200_000_000L;
    List<UserIdentifier> userIdentifiers1 = Arrays.asList(createUserIdentifier(OfflineDataUploadUserIdentifierType.HASHED_EMAIL, emailAddresses.get(0)), createUserIdentifier(OfflineDataUploadUserIdentifierType.STATE, "New York"));
    offlineDataList.add(createOfflineData(transactionTime1, transactionAmount1, "USD", conversionName, userIdentifiers1));
    // Create the second offline data for upload.
    // This transaction occurred 14 days ago with amount of 450 EUR.
    DateTime transactionTime2 = DateTime.now().minusDays(14);
    long transactionAmount2 = 450_000_000L;
    List<UserIdentifier> userIdentifiers2 = Arrays.asList(createUserIdentifier(OfflineDataUploadUserIdentifierType.HASHED_EMAIL, emailAddresses.get(1)), createUserIdentifier(OfflineDataUploadUserIdentifierType.STATE, "California"));
    offlineDataList.add(createOfflineData(transactionTime2, transactionAmount2, "EUR", conversionName, userIdentifiers2));
    // Create offline data upload object.
    OfflineDataUpload offlineDataUpload = new OfflineDataUpload();
    offlineDataUpload.setExternalUploadId(externalUploadId);
    offlineDataUpload.setOfflineDataList(offlineDataList.toArray(new OfflineData[offlineDataList.size()]));
    offlineDataUpload.setUploadType(offlineDataUploadType);
    // Set the type and metadata of this upload.
    StoreSalesUploadCommonMetadata storeSalesUploadMetadata;
    if (OfflineDataUploadType.STORE_SALES_UPLOAD_FIRST_PARTY.equals(offlineDataUploadType)) {
        storeSalesUploadMetadata = new FirstPartyUploadMetadata();
    } else {
        ThirdPartyUploadMetadata thirdPartyUploadMetadata = new ThirdPartyUploadMetadata();
        thirdPartyUploadMetadata.setAdvertiserUploadTime(advertiserUploadTime);
        thirdPartyUploadMetadata.setValidTransactionRate(1.0);
        thirdPartyUploadMetadata.setPartnerMatchRate(1.0);
        thirdPartyUploadMetadata.setPartnerUploadRate(1.0);
        thirdPartyUploadMetadata.setBridgeMapVersionId(bridgeMapVersionId);
        thirdPartyUploadMetadata.setPartnerId(partnerId);
        storeSalesUploadMetadata = thirdPartyUploadMetadata;
    }
    storeSalesUploadMetadata.setLoyaltyRate(1.0);
    storeSalesUploadMetadata.setTransactionUploadRate(1.0);
    UploadMetadata uploadMetadata = new UploadMetadata();
    uploadMetadata.setStoreSalesUploadCommonMetadata(storeSalesUploadMetadata);
    offlineDataUpload.setUploadMetadata(uploadMetadata);
    // Create an offline data upload operation.
    List<OfflineDataUploadOperation> operations = new ArrayList<>();
    OfflineDataUploadOperation offlineDataUploadOperation = new OfflineDataUploadOperation();
    offlineDataUploadOperation.setOperator(Operator.ADD);
    offlineDataUploadOperation.setOperand(offlineDataUpload);
    operations.add(offlineDataUploadOperation);
    // Upload offline data on the server and print some information.
    OfflineDataUploadReturnValue returnValue = offlineDataUploadService.mutate(operations.toArray(new OfflineDataUploadOperation[0]));
    offlineDataUpload = returnValue.getValue(0);
    System.out.printf("Uploaded offline data with external upload ID %d, and upload status %s.%n", offlineDataUpload.getExternalUploadId(), offlineDataUpload.getUploadStatus());
    // Print any partial failure errors from the response.
    if (returnValue.getPartialFailureErrors() != null) {
        for (ApiError apiError : returnValue.getPartialFailureErrors()) {
            // Get the index of the failed operation from the error's field path elements.
            Integer operationIndex = getFieldPathElementIndex(apiError, "operations");
            if (operationIndex != null) {
                OfflineDataUpload failedOfflineDataUpload = operations.get(operationIndex).getOperand();
                // Get the index of the entry in the offline data list from the error's field path
                // elements.
                Integer offlineDataListIndex = getFieldPathElementIndex(apiError, "offlineDataList");
                System.out.printf("Offline data list entry %d in operation %d with external upload ID %d and type " + "'%s' has triggered a failure for the following reason: '%s'.%n", offlineDataListIndex, operationIndex, failedOfflineDataUpload.getExternalUploadId(), failedOfflineDataUpload.getUploadType(), apiError.getErrorString());
            } else {
                System.out.printf("A failure has occurred for the following reason: %s%n", apiError.getErrorString());
            }
        }
    }
}
Also used : OfflineData(com.google.api.ads.adwords.axis.v201809.rm.OfflineData) OfflineDataUploadReturnValue(com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadReturnValue) ArrayList(java.util.ArrayList) DateTime(org.joda.time.DateTime) StoreSalesUploadCommonMetadata(com.google.api.ads.adwords.axis.v201809.rm.StoreSalesUploadCommonMetadata) ThirdPartyUploadMetadata(com.google.api.ads.adwords.axis.v201809.rm.ThirdPartyUploadMetadata) FirstPartyUploadMetadata(com.google.api.ads.adwords.axis.v201809.rm.FirstPartyUploadMetadata) OfflineDataUploadServiceInterface(com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadServiceInterface) FirstPartyUploadMetadata(com.google.api.ads.adwords.axis.v201809.rm.FirstPartyUploadMetadata) ThirdPartyUploadMetadata(com.google.api.ads.adwords.axis.v201809.rm.ThirdPartyUploadMetadata) UploadMetadata(com.google.api.ads.adwords.axis.v201809.rm.UploadMetadata) OfflineDataUploadOperation(com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadOperation) ApiError(com.google.api.ads.adwords.axis.v201809.cm.ApiError) UserIdentifier(com.google.api.ads.adwords.axis.v201809.rm.UserIdentifier) OfflineDataUpload(com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUpload)

Aggregations

ApiError (com.google.api.ads.adwords.axis.v201809.cm.ApiError)2 ApiException (com.google.api.ads.adwords.axis.v201809.cm.ApiException)1 FirstPartyUploadMetadata (com.google.api.ads.adwords.axis.v201809.rm.FirstPartyUploadMetadata)1 OfflineData (com.google.api.ads.adwords.axis.v201809.rm.OfflineData)1 OfflineDataUpload (com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUpload)1 OfflineDataUploadOperation (com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadOperation)1 OfflineDataUploadReturnValue (com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadReturnValue)1 OfflineDataUploadServiceInterface (com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadServiceInterface)1 OfflineDataUploadType (com.google.api.ads.adwords.axis.v201809.rm.OfflineDataUploadType)1 StoreSalesUploadCommonMetadata (com.google.api.ads.adwords.axis.v201809.rm.StoreSalesUploadCommonMetadata)1 ThirdPartyUploadMetadata (com.google.api.ads.adwords.axis.v201809.rm.ThirdPartyUploadMetadata)1 UploadMetadata (com.google.api.ads.adwords.axis.v201809.rm.UploadMetadata)1 UserIdentifier (com.google.api.ads.adwords.axis.v201809.rm.UserIdentifier)1 AdWordsSession (com.google.api.ads.adwords.lib.client.AdWordsSession)1 AdWordsServicesInterface (com.google.api.ads.adwords.lib.factory.AdWordsServicesInterface)1 ConfigurationLoadException (com.google.api.ads.common.lib.conf.ConfigurationLoadException)1 OAuthException (com.google.api.ads.common.lib.exception.OAuthException)1 ValidationException (com.google.api.ads.common.lib.exception.ValidationException)1 Credential (com.google.api.client.auth.oauth2.Credential)1 UnsupportedEncodingException (java.io.UnsupportedEncodingException)1