Data Manager API . accountTypes . accounts . insights

close()

Close httplib2 connections.

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

Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

Args:
  parent: string, Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DM API MarketingDataInsightsService.RetrieveInsights
  "baseline": { # Baseline criteria against which insights are compared. # Required. Baseline for the insights requested.
    "baselineLocation": { # The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions. # The baseline location of the request. Baseline location is an OR-list of the requested regions.
      "regionCodes": [ # List of ISO 3166-1 alpha-2 region codes.
        "A String",
      ],
    },
    "locationAutoDetectionEnabled": True or False, # If set to true, the service will try to automatically detect the baseline location for insights.
  },
  "userListId": "A String", # Required. The user list ID for which insights are requested.
}

  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 DM API MarketingDataInsightsService.RetrieveInsights
  "marketingDataInsights": [ # Contains the insights for the marketing data.
    { # Insights for marketing data. This feature is only available to data partners.
      "attributes": [ # Insights for values of a given dimension.
        { # Insights for a collection of related attributes of the same dimension.
          "ageRange": "A String", # Age range of the audience for which the lift is provided.
          "gender": "A String", # Gender of the audience for which the lift is provided.
          "lift": 3.14, # Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].
          "userInterestId": "A String", # The user interest ID.
        },
      ],
      "dimension": "A String", # The dimension to which the insight belongs.
    },
  ],
}