Merchant API . accounts . loyaltyCustomers

close()

Close httplib2 connections.

manage(parent, body=None, x__xgafv=None)

Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.

Args:
  parent: string, Required. The parent account where this loyalty customer will be handled. Format: `accounts/{account}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the ManageLoyaltyCustomerMatch method.
  "loyaltyCustomer": { # Represents a customer’s loyalty information. Represents loyalty customer data in `ManageLoyaltyCustomerMatch` API, but is not a resource that can be retrieved or listed by other methods. # Required. The loyalty customer to insert, update, or remove.
    "loyaltyTier": "A String", # Required. The tier label of the loyalty tier the customer belongs to.
    "pointBalance": "A String", # Optional. The point balance of the loyalty customer.
    "userIdentifier": { # The user identifiers associated with the customer. At least one of the fields within this message must be provided. # Required. The identifiers for the customer.
      "address": { # Represents a customer’s physical address. # Optional. The customer’s physical address.
        "city": "A String", # Optional. The city of the customer.
        "familyName": "A String", # Optional. The family name of the customer.
        "givenName": "A String", # Optional. The given name of the customer.
        "postalCode": "A String", # Optional. The postal code (zip code) of the customer. **Format Rules:** * **United States:** 5-digit zip codes (e.g., "94108").
        "regionCode": "A String", # Optional. The Unicode country/region code (CLDR) of the customer, such as "US" or "CH". This field is case-insensitive. For more information, see https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html.
        "state": "A String", # Optional. The state or province of the customer.
      },
      "emailAddress": "A String", # Optional. The customer’s email address.
      "phoneNumber": "A String", # Optional. The customer's phone number, in [E.164 format](https://support.google.com/google-ads/answer/16355235) (e.g., "+16502530000").
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the ManageLoyaltyCustomerMatch method.
  "loyaltyCustomer": { # Represents a customer’s loyalty information. Represents loyalty customer data in `ManageLoyaltyCustomerMatch` API, but is not a resource that can be retrieved or listed by other methods. # The loyalty customer that was inserted, updated, or removed. If the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization, this field will contain a default `LoyaltyCustomer` instance.
    "loyaltyTier": "A String", # Required. The tier label of the loyalty tier the customer belongs to.
    "pointBalance": "A String", # Optional. The point balance of the loyalty customer.
    "userIdentifier": { # The user identifiers associated with the customer. At least one of the fields within this message must be provided. # Required. The identifiers for the customer.
      "address": { # Represents a customer’s physical address. # Optional. The customer’s physical address.
        "city": "A String", # Optional. The city of the customer.
        "familyName": "A String", # Optional. The family name of the customer.
        "givenName": "A String", # Optional. The given name of the customer.
        "postalCode": "A String", # Optional. The postal code (zip code) of the customer. **Format Rules:** * **United States:** 5-digit zip codes (e.g., "94108").
        "regionCode": "A String", # Optional. The Unicode country/region code (CLDR) of the customer, such as "US" or "CH". This field is case-insensitive. For more information, see https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html.
        "state": "A String", # Optional. The state or province of the customer.
      },
      "emailAddress": "A String", # Optional. The customer’s email address.
      "phoneNumber": "A String", # Optional. The customer's phone number, in [E.164 format](https://support.google.com/google-ads/answer/16355235) (e.g., "+16502530000").
    },
  },
}