Search in sources :

Example 16 with CustomFieldServiceInterface

use of com.google.api.ads.admanager.axis.v202202.CustomFieldServiceInterface in project googleads-java-lib by googleads.

the class DeactivateCustomFields method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customFieldId the ID of the custom field to deactivate.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long customFieldId) throws RemoteException {
    // Get the CustomFieldService.
    CustomFieldServiceInterface customFieldService = adManagerServices.get(session, CustomFieldServiceInterface.class);
    // Create a statement to select a custom field.
    StatementBuilder statementBuilder = new StatementBuilder().where("WHERE id = :id").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("id", customFieldId);
    // Default for total result set size.
    int totalResultSetSize = 0;
    do {
        // Get custom fields by statement.
        CustomFieldPage page = customFieldService.getCustomFieldsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (CustomField customField : page.getResults()) {
                System.out.printf("%d) Custom field with ID %d will be deactivated.%n", i++, customField.getId());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of custom fields to be deactivated: %d%n", totalResultSetSize);
    if (totalResultSetSize > 0) {
        // Remove limit and offset from statement.
        statementBuilder.removeLimitAndOffset();
        // Create action.
        com.google.api.ads.admanager.axis.v202111.DeactivateCustomFields action = new com.google.api.ads.admanager.axis.v202111.DeactivateCustomFields();
        // Perform action.
        UpdateResult result = customFieldService.performCustomFieldAction(action, statementBuilder.toStatement());
        if (result != null && result.getNumChanges() > 0) {
            System.out.printf("Number of custom fields deactivated: %d%n", result.getNumChanges());
        } else {
            System.out.println("No custom fields were deactivated.");
        }
    }
}
Also used : CustomFieldServiceInterface(com.google.api.ads.admanager.axis.v202111.CustomFieldServiceInterface) CustomFieldPage(com.google.api.ads.admanager.axis.v202111.CustomFieldPage) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder) CustomField(com.google.api.ads.admanager.axis.v202111.CustomField) UpdateResult(com.google.api.ads.admanager.axis.v202111.UpdateResult)

Example 17 with CustomFieldServiceInterface

use of com.google.api.ads.admanager.axis.v202202.CustomFieldServiceInterface in project googleads-java-lib by googleads.

the class UpdateCustomFields method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param customFieldId the ID of the custom field to update.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long customFieldId) throws RemoteException {
    // Get the CustomFieldService.
    CustomFieldServiceInterface customFieldService = adManagerServices.get(session, CustomFieldServiceInterface.class);
    // Create a statement to only select a single custom field by ID.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(1).withBindVariableValue("id", customFieldId);
    // Get the custom field.
    CustomFieldPage page = customFieldService.getCustomFieldsByStatement(statementBuilder.toStatement());
    CustomField customField = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    // Update the custom field description.
    customField.setDescription("New custom field description");
    // Update the custom field on the server.
    CustomField[] customFields = customFieldService.updateCustomFields(new CustomField[] { customField });
    for (CustomField updatedCustomField : customFields) {
        System.out.printf("Custom field with ID %d and name '%s' was updated.%n", updatedCustomField.getId(), updatedCustomField.getName());
    }
}
Also used : CustomFieldPage(com.google.api.ads.admanager.axis.v202111.CustomFieldPage) CustomFieldServiceInterface(com.google.api.ads.admanager.axis.v202111.CustomFieldServiceInterface) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder) CustomField(com.google.api.ads.admanager.axis.v202111.CustomField)

Example 18 with CustomFieldServiceInterface

use of com.google.api.ads.admanager.axis.v202202.CustomFieldServiceInterface in project googleads-java-lib by googleads.

the class SetLineItemCustomFieldValue method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param numberCustomFieldId the ID of the number typed custom field to set on the line item.
 * @param customFieldOptionId the ID of the option for the drop-down custom field.
 * @param lineItemId the ID of the line item to set these custom fields.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long numberCustomFieldId, long customFieldOptionId, long lineItemId) throws RemoteException {
    // Get the CustomFieldService.
    CustomFieldServiceInterface customFieldService = adManagerServices.get(session, CustomFieldServiceInterface.class);
    // Get the LineItemService.
    LineItemServiceInterface lineItemService = adManagerServices.get(session, LineItemServiceInterface.class);
    // Get the drop-down custom field ID.
    long dropDownCustomFieldId = customFieldService.getCustomFieldOption(customFieldOptionId).getCustomFieldId();
    // Create a statement to only select a single line item by ID.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(1).withBindVariableValue("id", lineItemId);
    // Get the line item.
    LineItemPage page = lineItemService.getLineItemsByStatement(statementBuilder.toStatement());
    LineItem lineItem = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    // Create number custom field value.
    NumberValue numberValue = new NumberValue();
    numberValue.setValue("12345");
    CustomFieldValue numberCustomFieldValue = new CustomFieldValue();
    numberCustomFieldValue.setCustomFieldId(numberCustomFieldId);
    numberCustomFieldValue.setValue(numberValue);
    // Create drop-down custom field value.
    DropDownCustomFieldValue dropDownCustomFieldValue = new DropDownCustomFieldValue();
    dropDownCustomFieldValue.setCustomFieldId(dropDownCustomFieldId);
    dropDownCustomFieldValue.setCustomFieldOptionId(customFieldOptionId);
    // Create a combined custom field value list of existing different custom
    // field values and new ones.
    List<BaseCustomFieldValue> combinedCustomFieldValues = new ArrayList<>();
    if (lineItem.getCustomFieldValues() != null) {
        for (BaseCustomFieldValue existingCustomFieldValue : lineItem.getCustomFieldValues()) {
            if (!existingCustomFieldValue.getCustomFieldId().equals(numberCustomFieldId) && !existingCustomFieldValue.getCustomFieldId().equals(dropDownCustomFieldId)) {
                combinedCustomFieldValues.add(existingCustomFieldValue);
            }
        }
    }
    combinedCustomFieldValues.addAll(Arrays.asList(numberCustomFieldValue, dropDownCustomFieldValue));
    // Set the combined custom field values.
    lineItem.setCustomFieldValues(combinedCustomFieldValues.toArray(new BaseCustomFieldValue[] {}));
    // Update the line item on the server.
    LineItem[] lineItems = lineItemService.updateLineItems(new LineItem[] { lineItem });
    for (LineItem updatedLineItem : lineItems) {
        // Get a string representation of the custom field values.
        List<String> customFieldValueStrings = Lists.transform(Arrays.asList(updatedLineItem.getCustomFieldValues()), new Function<BaseCustomFieldValue, String>() {

            @Override
            public String apply(BaseCustomFieldValue baseCustomFieldValue) {
                if (baseCustomFieldValue instanceof CustomFieldValue && ((CustomFieldValue) baseCustomFieldValue).getValue() instanceof NumberValue) {
                    return String.format("{ID: %d, value: %.0f}", baseCustomFieldValue.getCustomFieldId(), Double.parseDouble(((NumberValue) ((CustomFieldValue) baseCustomFieldValue).getValue()).getValue()));
                } else if (baseCustomFieldValue instanceof DropDownCustomFieldValue) {
                    return String.format("{ID: %d, customFieldOptionId: %d}", baseCustomFieldValue.getCustomFieldId(), ((DropDownCustomFieldValue) baseCustomFieldValue).getCustomFieldOptionId());
                } else {
                    return "{Unrecognized value}";
                }
            }
        });
        System.out.printf("A line item with ID %d was updated with custom field values '%s'%n", updatedLineItem.getId(), Joiner.on(",").join(customFieldValueStrings));
    }
}
Also used : CustomFieldValue(com.google.api.ads.admanager.axis.v202111.CustomFieldValue) DropDownCustomFieldValue(com.google.api.ads.admanager.axis.v202111.DropDownCustomFieldValue) BaseCustomFieldValue(com.google.api.ads.admanager.axis.v202111.BaseCustomFieldValue) DropDownCustomFieldValue(com.google.api.ads.admanager.axis.v202111.DropDownCustomFieldValue) BaseCustomFieldValue(com.google.api.ads.admanager.axis.v202111.BaseCustomFieldValue) LineItemServiceInterface(com.google.api.ads.admanager.axis.v202111.LineItemServiceInterface) CustomFieldServiceInterface(com.google.api.ads.admanager.axis.v202111.CustomFieldServiceInterface) ArrayList(java.util.ArrayList) LineItem(com.google.api.ads.admanager.axis.v202111.LineItem) NumberValue(com.google.api.ads.admanager.axis.v202111.NumberValue) LineItemPage(com.google.api.ads.admanager.axis.v202111.LineItemPage) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder)

Aggregations

CustomFieldServiceInterface (com.google.api.ads.admanager.axis.v202108.CustomFieldServiceInterface)6 CustomFieldServiceInterface (com.google.api.ads.admanager.axis.v202111.CustomFieldServiceInterface)6 CustomFieldServiceInterface (com.google.api.ads.admanager.axis.v202202.CustomFieldServiceInterface)6 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder)5 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder)5 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202202.StatementBuilder)5 CustomField (com.google.api.ads.admanager.axis.v202108.CustomField)5 CustomField (com.google.api.ads.admanager.axis.v202111.CustomField)5 CustomField (com.google.api.ads.admanager.axis.v202202.CustomField)5 CustomFieldPage (com.google.api.ads.admanager.axis.v202108.CustomFieldPage)4 CustomFieldPage (com.google.api.ads.admanager.axis.v202111.CustomFieldPage)4 CustomFieldPage (com.google.api.ads.admanager.axis.v202202.CustomFieldPage)4 ArrayList (java.util.ArrayList)3 Random (java.util.Random)3 BaseCustomFieldValue (com.google.api.ads.admanager.axis.v202108.BaseCustomFieldValue)1 CustomFieldOption (com.google.api.ads.admanager.axis.v202108.CustomFieldOption)1 CustomFieldValue (com.google.api.ads.admanager.axis.v202108.CustomFieldValue)1 DropDownCustomFieldValue (com.google.api.ads.admanager.axis.v202108.DropDownCustomFieldValue)1 LineItem (com.google.api.ads.admanager.axis.v202108.LineItem)1 LineItemPage (com.google.api.ads.admanager.axis.v202108.LineItemPage)1